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 and complete docstrings #331

Open
toni-neurosc opened this issue Jun 10, 2024 · 2 comments
Open

Update and complete docstrings #331

toni-neurosc opened this issue Jun 10, 2024 · 2 comments
Assignees
@toni-neurosc @timonmerk

Comments

@toni-neurosc
Copy link
Collaborator

As changes have accumulated, many of the docstrings that the automated documentation is built off are either missing or outdated.

In order to ensure a correct and complete documentation, docstrings need to be updated all across the project, starting with the nm_settings module.

Related PR: #329
@toni-neurosc toni-neurosc changed the title Update or add docstrings Update and complete docstrings Jun 10, 2024
@timonmerk
Copy link
Contributor

Great! Let's work on this once the API is fixed and #329 is ready to be merged

@timonmerk
Copy link
Contributor

Just to let you know, I am working on this now @toni-neurosc

@timonmerk timonmerk mentioned this issue Jun 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@toni-neurosc toni-neurosc

@timonmerk timonmerk

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@toni-neurosc @timonmerk