-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
docs: unify no trailing dots in docstrings and help #11301
docs: unify no trailing dots in docstrings and help #11301
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
This looks good, and agreed that it's more consistent with CLI conventions.
You will need to rebase/force-push your commit to add the DCO before I can accept the PR, however. See the instructions @ https://github.com/docker/compose/pull/11301/checks?check_run_id=19909474681.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #11301 +/- ##
==========================================
- Coverage 58.18% 58.16% -0.03%
==========================================
Files 136 136
Lines 11587 11587
==========================================
- Hits 6742 6739 -3
- Misses 4182 4185 +3
Partials 663 663 ☔ View full report in Codecov by Sentry. |
25ae9d0
to
62758d9
Compare
Thanks, I've just added the missing signoff. |
I see some checks have failed. Will look into it and fix the problems but no earlier than in 10 days or so as I'm afk. |
@PiotrDabrowskey looking at the failing job, it looks like you need to run |
Head branch was pushed to by a user without write access
d5f949e
to
d5ff34d
Compare
I've fixed the problems detected by checks and rebased resolving conflicts from the main branch. |
d5ff34d
to
dd51e83
Compare
Head branch was pushed to by a user without write access
dd51e83
to
887a97d
Compare
Signed-off-by: Piotr Dąbrowski <piotr.dabrowski.sbk@gmail.com>
887a97d
to
0d30a78
Compare
Sorry, I've missed the linter error - fixed now. I've also rebased on current |
Thanks again! Sorry this was a little tricky to get merged 🙃 |
it sucks...
What I did
Some docstrings and help strings ends with a trailing dot, but most of do not. Current state is that even
docker compose
output lists some args and commands with a trailing dot, which is not eye pleasing. I've unified this styling but only in short/one-line string. Multi-line and most of multi-sentence docstrings have been left intact.If such changes are not welcomed, let me know and I'll close the PR (or just close it by yourself).
Related issue
N/A
A picture of a cute animal, if possible in relation to what you did
![image](https://private-user-images.githubusercontent.com/9080823/292604053-094f0e3c-8192-4582-960a-49ce43cdbf8c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAxMTUwODUsIm5iZiI6MTcyMDExNDc4NSwicGF0aCI6Ii85MDgwODIzLzI5MjYwNDA1My0wOTRmMGUzYy04MTkyLTQ1ODItOTYwYS00OWNlNDNjZGJmOGMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDRUMTczOTQ1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YzhlNzQ3NGJjNDE0MWM1NmU0YmQ3YWY2MGE3NmYxNWQyMTk2ZmU0NTI3MmI4Y2MyYjI5ZWZhNzk5MDAyNzAwMyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.Cza_OtiVdU_-zb724gapoLh1UHUVXwVKJ23WaAY6GZs)
Nela 🐾