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.

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

Update docstrings dynamically #7

Open
pedrorrivero opened this issue Oct 20, 2022 · 0 comments
Open

Update docstrings dynamically #7

pedrorrivero opened this issue Oct 20, 2022 · 0 comments
Labels
DC-2 Difficulty class 2/5 → Application/user level knowledge documentation Improvements or additions to documentation enhancement New non-feature request (e.g. performance) help wanted Extra attention is needed PL-5 Priority level 5/5 → Low

Comments

@pedrorrivero
Copy link
Member

pedrorrivero commented Oct 20, 2022 •
edited
Loading

What is the expected enhancement?

Currently, the meta module takes care of adding the required functionality to implement the different stages of ZNE, but it does not update the docstrings of the relevant methods and classes to account for it. The reason for this —and main challenge— is that they need to be updated dynamically (i.e. for any given class and its associated methods).

This will require an upgrade to the current docstrings util.
@pedrorrivero pedrorrivero added enhancement New non-feature request (e.g. performance) help wanted Extra attention is needed DC-2 Difficulty class 2/5 → Application/user level knowledge PL-5 Priority level 5/5 → Low labels Oct 20, 2022
@pedrorrivero pedrorrivero changed the title Update docstrings Update docstrings dynamically Oct 20, 2022
@pedrorrivero pedrorrivero added the documentation Improvements or additions to documentation label Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
DC-2 Difficulty class 2/5 → Application/user level knowledge documentation Improvements or additions to documentation enhancement New non-feature request (e.g. performance) help wanted Extra attention is needed PL-5 Priority level 5/5 → Low
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pedrorrivero