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.

Sign up for GitHub

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

Jump to bottom

[DOC] improved docstrings for `BaseObject` #369

Merged

fkiraly merged 3 commits into main from docstrings-improved

Oct 1, 2024

Contributor

fkiraly commented Sep 30, 2024

Improves the docstrings of methods in BaseObject by:

ensuring proper rst formatting throughout
cleraly explaining difference between tags and configs
clearly explaining state and returns of tags and config objects
making more complete explanations of input-output behaviour


          Update _base.py

4b86931

fkiraly added the documentation label

pre-commit-ci bot and others added 2 commits

September 30, 2024 11:20


          [pre-commit.ci] auto fixes from pre-commit.com hooks

f073698

for more information, see https://pre-commit.ci


          improved

9a966a4

fkiraly merged commit 2c2acdb into main

24 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels