Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend the Sphinx docs by a page about the concepts of ConfigUpdater #17

Open
FlorianWilhelm opened this issue Feb 28, 2021 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@FlorianWilhelm
Copy link
Member

FlorianWilhelm commented Feb 28, 2021

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:

  1. navigation, e.g. first/last_block of a container or next/previous_block of a block
  2. creation, e.g. add_before/after.comment/option/space
  3. removal, e.g. block.remove
  4. inspection, e.g. option_blocks
  5. etc.
@FlorianWilhelm FlorianWilhelm added help wanted Extra attention is needed good first issue Good for newcomers labels Feb 28, 2021
abravalheri added a commit that referenced this issue Jun 14, 2021
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.
abravalheri added a commit that referenced this issue Jun 14, 2021
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant