You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
This closes#29.
For the time being not many changes are introduced in the docs, just the
logos being uploaded.
In the near feature, when #17 and #18 are addressed, we might do a
better use of it.
This closes#29.
For the time being not many changes are introduced in the docs, just the
logos being uploaded.
In the near feature, when #17 and #18 are addressed, we might do a
better use of it.
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 holdingBlock
objects.ConfigUpdater
itself is aContainer
and alsoSection
.Option
,Space
,Comment
but alsoSection
areBlock
objects.Now there are several methods for:
first/last_block
of a container ornext/previous_block
of a blockadd_before/after.comment/option/space
block.remove
option_blocks
The text was updated successfully, but these errors were encountered: