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

improvement on docs #232

Closed
CunliangGeng opened this issue Mar 22, 2024 · 1 comment
Closed

improvement on docs #232

CunliangGeng opened this issue Mar 22, 2024 · 1 comment
Labels
docs documentations

Comments

@CunliangGeng
Copy link
Member

Please leave your comments (questions, problems, suggestions, advice, ideas...) below about the doc website https://nplinker.github.io/nplinker/latest/.
@CunliangGeng CunliangGeng added the docs documentations label Mar 22, 2024
@CunliangGeng CunliangGeng mentioned this issue Mar 22, 2024
Closed
@CunliangGeng
Copy link
Member Author

CunliangGeng commented Mar 27, 2024 •
edited

The types of attributes are not displayed since they are documented in __init__ method, which should be supported by mkdocstring-python (see issue mkdocstrings/python#144).

Followup: it won't be supported by mkdocstring-python.
So it's necessary to put the attributes docstrings on class level, see example.

Fixed in PR #239

@CunliangGeng CunliangGeng mentioned this issue Apr 11, 2024
Merged
CunliangGeng added a commit that referenced this issue Apr 18, 2024
@CunliangGeng
Fix locations of attributes docstrings
5921a82 
To solve the issue #232 (comment).

The docstrings of attributes are moved to from `__init__` level to class level.

Other changes:
- fix format and static typing errors
- update settings for format and static typing check
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs documentations
Projects
dev
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CunliangGeng