Skip to content

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Feb 22, 2021

Part of #1665
Fixes #1665

Description: only show type hints in docstring not in signatures, better readability in signatures, less work in adding type hints, less type hints mismatch occurence

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)

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, thanks @ydcjeff !
Please, add suggested doc fixes to restore crosslinks.

@vfdev-5 vfdev-5 merged commit e5f4172 into pytorch:master Feb 22, 2021
@ydcjeff ydcjeff deleted the ignite.contrib.engines branch February 22, 2021 17:16
vfdev-5 added a commit that referenced this pull request Mar 1, 2021
* docs: only show type hints in docstring

* Apply suggestions from code review

Co-authored-by: vfdev <vfdev.5@gmail.com>

* fix(docs): correctly link to missing links

Co-authored-by: vfdev <vfdev.5@gmail.com>
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

2 participants