Skip to content

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Feb 23, 2021

Part of #1665
Fixes #1665
https://deploy-preview-1686--pytorch-ignite-preview.netlify.app/metrics.html

Description:

  • remove type hints in ignite.metrics
  • add missing doc strings

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

@ydcjeff ydcjeff changed the title docs: rm type hints in ignite.metrics docs: rm type hints in ignite.metrics (4) Feb 23, 2021
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Feb 23, 2021

@ydcjeff I propose to insert another PR before this one with sphinx version update and all those conf.py flags. What do you think ?

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Feb 23, 2021

@ydcjeff I propose to insert another PR before this one with sphinx version update and all those conf.py flags. What do you think ?

Sounds great

Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thanks @ydcjeff

I let others to review this PR as well

@vfdev-5 vfdev-5 requested a review from sdesrozis February 24, 2021 09:02
Copy link
Contributor

@sdesrozis sdesrozis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ydcjeff Looks good to me. Thank you, especially for adding missing docstring regarding arguments of methods.

@vfdev-5 vfdev-5 merged commit d6a179e into pytorch:master Feb 24, 2021
@ydcjeff ydcjeff deleted the ignite.metrics branch February 25, 2021 02:25
vfdev-5 pushed a commit that referenced this pull request Mar 1, 2021
* docs: rm type hints in ignite.metrics

* fix: down sphinx=3.2.1, normalize

* fix: down sphinx=3.2.1, normalize
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use autodoc_typehints = "description" in conf.py
3 participants