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.

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

in-comment type hint rich linking and parameter defaults #204

Merged
merged 6 commits into from Jun 8, 2022

Conversation

itsdawei
Copy link
Collaborator

@itsdawei itsdawei commented Jun 8, 2022

Description

Add type hint rich linking and defaults to pyribs documentation

TODO

  • Add (in-comment) type hint rich linking to pyribs documentation
  • Add parameter defaults to pyribs documentation -> Will not do this since too difficult

Status

  • I have read the guidelines in CONTRIBUTING.md.
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in HISTORY.md.
  • This PR is ready to go

@itsdawei
Copy link
Collaborator Author

itsdawei commented Jun 8, 2022

Defaults does not work out-of-the-box with sphinx_autodoc_typehints if we do not provide in-code type hints. Won't fix this for now since it will be too much effort.

@itsdawei itsdawei marked this pull request as ready for review June 8, 2022 22:32
@itsdawei itsdawei requested a review from btjanaka June 8, 2022 22:32
@itsdawei itsdawei added the documentation Improvements or additions to documentation label Jun 8, 2022
HISTORY.md Show resolved Hide resolved
@itsdawei itsdawei merged commit 67a4ab6 into master Jun 8, 2022
@itsdawei itsdawei deleted the docs-rich-linking-and-defualts branch June 8, 2022 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants