Describe your use-case
Right now many features of ConfigUpdater are only explained by some examples in Spinx Usage page and thus it's cumbersome for new users to really understand how to use ConfigUpdater.
Describe the solution you would like to see for your use-case
Add a Sphinx page that explains the concepts of ConfigUpdater and which methods should be used in which context. The concept is basically that there are Container objects holding Block objects. ConfigUpdater itself is a Container and also Section. Option, Space, Comment but also Section are Block objects.
Now there are several methods for:
- navigation, e.g.
first/last_block of a container or next/previous_block of a block
- creation, e.g.
add_before/after.comment/option/space
- removal, e.g.
block.remove
- inspection, e.g.
option_blocks
- etc.
Describe your use-case
Right now many features of ConfigUpdater are only explained by some examples in Spinx Usage page and thus it's cumbersome for new users to really understand how to use ConfigUpdater.
Describe the solution you would like to see for your use-case
Add a Sphinx page that explains the concepts of ConfigUpdater and which methods should be used in which context. The concept is basically that there are
Containerobjects holdingBlockobjects.ConfigUpdateritself is aContainerand alsoSection.Option,Space,Commentbut alsoSectionareBlockobjects.Now there are several methods for:
first/last_blockof a container ornext/previous_blockof a blockadd_before/after.comment/option/spaceblock.removeoption_blocks