8000 docs: explicitly define constructor arguments by linkfrg · Pull Request #207 · linkfrg/ignis · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: explicitly define constructor arguments #207

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
Merged
merged 8 commits into from
Mar 20, 2025
Merged

docs: explicitly define constructor arguments #207

merged 8 commits into from
Mar 20, 2025

Conversation

linkfrg
Copy link
Owner
@linkfrg linkfrg commented Mar 18, 2025 •
edited
Loading

As a preparation for #177, this PR adds an explicit Args section to class docstrings (where needed).
This eliminates the need to specify - optional / required / not argument and makes it easier to understand what arguments the constructor accepts.

  • update dev docs

@linkfrg linkfrg added the documentation Improvements or additions to documentation label Mar 18, 2025
@linkfrg linkfrg marked this pull request as draft March 18, 2025 15:22
@linkfrg linkfrg mentioned this pull request Mar 18, 2025
Merged
2 tasks
@linkfrg linkfrg marked this pull request as ready for review March 20, 2025 19:22
@linkfrg linkfrg merged commit c0711af into main Mar 20, 2025
3 checks passed
@linkfrg linkfrg deleted the docs/explicit-init-args branch March 20, 2025 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@linkfrg
0