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

docs: unify no trailing dots in docstrings and help #11301

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

PiotrDabrowskey
Copy link
Contributor

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
Nela 🐾
image

@milas milas self-assigned this Jan 4, 2024
Copy link
Contributor

@milas milas left a 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.

Copy link

codecov bot commented Jan 4, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (3ba6645) 58.18% compared to head (0d30a78) 58.16%.
Report is 1 commits behind head on main.

Files Patch % Lines
pkg/compose/build.go 0.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

@PiotrDabrowskey
Copy link
Contributor Author

Thanks, I've just added the missing signoff.

@milas milas enabled auto-merge (squash) January 5, 2024 18:51
@PiotrDabrowskey
Copy link
Contributor Author

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.

@jhrotko
Copy link
Contributor

jhrotko commented Jan 8, 2024

@PiotrDabrowskey looking at the failing job, it looks like you need to run make docs to update the docs/ folder with your changes

auto-merge was automatically disabled January 27, 2024 01:46

Head branch was pushed to by a user without write access

@PiotrDabrowskey PiotrDabrowskey force-pushed the unify-trailing-dots-in-help branch 2 times, most recently from d5f949e to d5ff34d Compare January 27, 2024 01:55
@PiotrDabrowskey
Copy link
Contributor Author

I've fixed the problems detected by checks and rebased resolving conflicts from the main branch.

@ndeloof ndeloof enabled auto-merge (rebase) February 8, 2024 14:45
auto-merge was automatically disabled February 10, 2024 14:19

Head branch was pushed to by a user without write access

Signed-off-by: Piotr Dąbrowski <piotr.dabrowski.sbk@gmail.com>
@PiotrDabrowskey
Copy link
Contributor Author

Sorry, I've missed the linter error - fixed now. I've also rebased on current main and rerun lint and docs to be sure. All should be green.

@milas milas merged commit e330f59 into docker:main Feb 14, 2024
30 checks passed
@milas
Copy link
Contributor

milas commented Feb 14, 2024

Thanks again! Sorry this was a little tricky to get merged 🙃

batcity pushed a commit to batcity/compose that referenced this pull request Feb 17, 2024
batcity pushed a commit to batcity/compose that referenced this pull request Feb 17, 2024
KingBridgeSS added a commit to KingBridgeSS/ctf-pow-for-docker-compose that referenced this pull request Mar 15, 2024
rarguelloF pushed a commit to rarguelloF/compose that referenced this pull request Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants