compose icon indicating copy to clipboard operation
compose copied to clipboard

docs: unify no trailing dots in docstrings and help

Open PiotrDabrowskey opened this issue 2 years ago • 4 comments

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 :feet: image

PiotrDabrowskey avatar Dec 23 '23 02:12 PiotrDabrowskey

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 :warning:
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              

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 04 '24 16:01 codecov[bot]

Thanks, I've just added the missing signoff.

PiotrDabrowskey avatar Jan 04 '24 17:01 PiotrDabrowskey

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 avatar Jan 05 '24 20:01 PiotrDabrowskey

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

jhrotko avatar Jan 08 '24 18:01 jhrotko

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

PiotrDabrowskey avatar Jan 27 '24 10:01 PiotrDabrowskey

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.

PiotrDabrowskey avatar Feb 10 '24 14:02 PiotrDabrowskey

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

milas avatar Feb 14 '24 19:02 milas