Skip to content

docs: rm type hints in ignite.utils (1) #1684

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 5 commits into from
Feb 23, 2021
Merged

docs: rm type hints in ignite.utils (1) #1684

merged 5 commits into from
Feb 23, 2021

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Feb 23, 2021 •
edited
Loading

Part of #1665
Fixes #1665

Description:

  • remove type hints in docstring of ignite.utils
  • changed input_ to x as input_: is parsed as link in rst

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)

vfdev-5
vfdev-5 reviewed Feb 23, 2021
View reviewed changes
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.

Thanks @ydcjeff ! A nit comment

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Feb 23, 2021

If this looks good, this can be merged first.

vfdev-5
vfdev-5 approved these changes Feb 23, 2021
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM! Thanks @ydcjeff !

I'll merge once CI is done

@ydcjeff ydcjeff changed the title docs: rm type hints in ignite.utils docs: rm type hints in ignite.utils (1) Feb 23, 2021
@ydcjeff
Copy link
Contributor Author

ydcjeff commented Feb 23, 2021

I have added number in my opened PRs that can be merged one after another.

@vfdev-5 vfdev-5 merged commit 37bcd10 into pytorch:master Feb 23, 2021
@ydcjeff ydcjeff deleted the ignite.utils branch February 23, 2021 13:23
@vfdev-5 vfdev-5 mentioned this pull request Feb 25, 2021
Closed
vfdev-5 pushed a commit that referenced this pull request Mar 1, 2021
@vfdev-5
docs: rm type hints in ignite.utils (1) (#1684)
e751042 
* docs: rm type hints in ignite.utils

* fix: change input_ to input in ignite.utils

* fix: change input to x
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use autodoc_typehints = "description" in conf.py
2 participants
@ydcjeff @vfdev-5