remove_permastruct()

[swissspidy]

As suggested in 35227#comment:3, it's worth adding a remove_permastruct() helper to make it easier cleaning up permastructs.

[boonebgorges]

A question about the semantics of the new function and method. remove_permastruct() will only allow for the removal of extra_permastructs, ie those that have been added via add_permastruct(). It won't be possible to use it to remove built-in, hardcoded permastructs like 'post_tag' or whatever. Is it worth considering a more descriptive name like remove_extra_permastruct()? Or is it enough to note the limitation in the documentation? (The latter seems right to me - I just want to get a second opinion on it.)

[swissspidy]

I tried to make remove_permastruct() the counter part to add_permastruct(), so I'd suggest making this clear in the documentation for both functions ("Add/remove extra permastruct").

[boonebgorges]

Replying to swissspidy:

I tried to make remove_permastruct() the counter part to add_permastruct(), so I'd suggest making this clear in the documentation for both functions ("Add/remove extra permastruct").

This sounds good to me. Something along the following lines should work: "This function can only be used to remove permastructs that were added using add_permastruct(). Built-in permastructs cannot be removed."

[swissspidy]

35235.2.diff​ is an updated patch with improved docs and slightly updated unit tests.

[boonebgorges]

35235.2.diff​ looks like a go to me.

[swissspidy]

In 36181:

Rewrite: Add a remove_permastruct() helper function.

It can be used to remove permastructs that were added using add_permastruct().

Fixes #35235.

[dd32]

In 36183:

Unit Tests: Fix the unit test added in [36181] to include the index in the comparison.

See #35235

[DrewAPicture]

In 36960:

Docs: Use a third-person singular verb for the DocBlock summary for remove_permastruct(), introduced in [36181].

See #35235. See #35986.