-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
CLI only shows first line, this helps the summary fit inside
for more information, see https://pre-commit.ci
awaelchli
approved these changes
Jan 27, 2024
Codecov Report
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 |
pardon the following attempts to get this playing nice with your linter (am editing through github directly). |
spacing
for more information, see https://pre-commit.ci
spacing (again)
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
linter was auto-fixing lines before and all of the sudden chose not to.
for more information, see https://pre-commit.ci
Borda
approved these changes
Jan 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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](https://private-user-images.githubusercontent.com/40366263/300220247-f4cbe602-5e20-4686-a10f-53d37646b7c8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkxNjQ3NDYsIm5iZiI6MTczOTE2NDQ0NiwicGF0aCI6Ii80MDM2NjI2My8zMDAyMjAyNDctZjRjYmU2MDItNWUyMC00Njg2LWExMGYtNTNkMzc2NDZiN2M4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjEwVDA1MTQwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdkZDA1MWYzMzliNTI5YzFlNGEyNzY4YjZiMzJjMDQ0NWM3NzcxMmIwZjcxZGQ0NmNmMmZmOWNjNzI4MjVmYmImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.2DnZ4b35SgQPGzlQy56qWpxiu68yhMv43iRmUadZHyc)
No issue - not worth bringing one up IMO for such a minor change.
Before submitting
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
📚 Documentation preview 📚: https://pytorch-lightning--19356.org.readthedocs.build/en/19356/