Skip to content

Conversation

@JiahaoYao
Copy link
Contributor

What does this PR do?

Fixes #<issue_number>

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@akihironitta akihironitta added the docs Documentation related label Jul 10, 2022
@akihironitta akihironitta added this to the pl:1.7 milestone Jul 10, 2022
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

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

in fact, I think we shall remove all defaults from docstring as it duplicates of function footprint and source os misalignments...

@akihironitta
Copy link
Contributor

@Borda There was a similar comment #11614 (comment) by @awaelchli.

Currently, the sphinx doc generator adds the default values automatically to the rendered docs page based on the default values specified in the signature. We have discussed manually adding these for each parameter in the past, like you did here. The maintenance effort is higher: when a default value changes, it needs to be updated manually in the docstring too. But considering that the trainer defaults don't change very often, and it is sometimes hard to read the docs, I am fine with either way :)

For the rest of the code base, I would let sphinx handle the defaults.

I'm fine with either way, too.

@awaelchli awaelchli changed the title fix typo Fix default value for enable_progress_bar in docs Jul 11, 2022
@mergify mergify bot added the ready PRs ready to be merged label Jul 11, 2022
@mergify mergify bot requested a review from a team July 11, 2022 10:12
@lexierule lexierule merged commit b9ceefb into Lightning-AI:master Jul 12, 2022
jerome-habana pushed a commit to jerome-habana/lightning that referenced this pull request Jul 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants