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

Shorten docstring (for CLI compat) #19356

Merged
merged 12 commits into from
Jan 30, 2024
Merged

Shorten docstring (for CLI compat) #19356

merged 12 commits into from
Jan 30, 2024

Conversation

mathematicalmichael
Copy link
Contributor

@mathematicalmichael mathematicalmichael commented Jan 27, 2024

CLI only shows first line, this helps the summary fit inside

What does this PR do?

updates a docstring to avoid sentence cut-off in Lightning CLI
image

No issue - not worth bringing one up IMO for such a minor change.

Before submitting
  • Was this discussed/agreed 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:

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--19356.org.readthedocs.build/en/19356/

CLI only shows first line, this helps the summary fit inside
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jan 27, 2024
@awaelchli awaelchli added the docs Documentation related label Jan 27, 2024
@awaelchli awaelchli added tuner community This PR is from the community labels Jan 27, 2024
@awaelchli awaelchli added this to the 2.2 milestone Jan 27, 2024
Copy link

codecov bot commented Jan 27, 2024

Codecov Report

Merging #19356 (a101fd8) into master (1a59097) will decrease coverage by 35%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #19356      +/-   ##
==========================================
- Coverage      84%      49%     -35%     
==========================================
  Files         448      440       -8     
  Lines       37854    37701     -153     
==========================================
- Hits        31623    18359   -13264     
- Misses       6231    19342   +13111     

@mathematicalmichael
Copy link
Contributor Author

mathematicalmichael commented Jan 27, 2024

pardon the following attempts to get this playing nice with your linter (am editing through github directly).

@awaelchli awaelchli requested a review from Borda January 29, 2024 14:31
@Borda Borda merged commit 5361acd into Lightning-AI:master Jan 30, 2024
93 checks passed
@mergify mergify bot added the ready PRs ready to be merged label Jan 30, 2024
@mathematicalmichael mathematicalmichael deleted the patch-1 branch February 6, 2024 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from the community docs Documentation related pl Generic label for PyTorch Lightning package ready PRs ready to be merged tuner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants