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

fix "docstring oddities" #175

Merged
merged 3 commits into from
Oct 27, 2020
Merged

Conversation

rfourquet
Copy link
Contributor

@rfourquet rfourquet commented Oct 27, 2020

Similar to Nemocas/AbstractAlgebra.jl#662:

  1. align signature to 4 spaces
  2. add a line between the signature and the description
  3. remove > characters at the beginning of lines in docstrings.

Perl commands:
$ perl -i -p -e 'BEGIN{undef $/;}  s/"""\n   (\S)/"""\n    \1/smg' $(find -name \*\.jl)
for examples directory:
$ perl -i -p -e 'BEGIN{undef $/;}  s/"""\n(\S.*)\n>/"""\n    \1\n>/g' $(find -name \*\.jl)
Perl command:
perl -i -p -e 'BEGIN{undef $/;}  s/"""\n((?:    \S.*\n)+)(\S)/"""\n\1\n\2/g' $(find -name \*\.jl)
Perl command:
perl -i -p -e 's/^> (.+)/\1/g' $(find -name \*\.jl)
@codecov
Copy link

codecov bot commented Oct 27, 2020

Codecov Report

Merging #175 into master will increase coverage by 0.17%.
The diff coverage is 43.09%.

@@            Coverage Diff             @@
##           master     #175      +/-   ##
==========================================
+ Coverage   41.70%   41.88%   +0.17%     
==========================================
  Files          22       23       +1     
  Lines        3141     3319     +178     
==========================================
+ Hits         1310     1390      +80     
- Misses       1831     1929      +98     
Impacted Files Coverage Δ
src/Groups/GAPGroups.jl 83.68% <0.00%> (ø)
src/Groups/cosets.jl 73.55% <ø> (ø)
src/Groups/directproducts.jl 93.97% <ø> (ø)
src/Groups/group_constructors.jl 88.57% <ø> (ø)
src/Groups/gsets.jl 15.00% <ø> (ø)
src/Groups/homomorphisms.jl 82.53% <ø> (ø)
src/Groups/libraries/perfectgroups.jl 100.00% <ø> (ø)
src/Groups/libraries/primitivegroups.jl 0.00% <ø> (ø)
src/Groups/libraries/smallgroups.jl 100.00% <ø> (ø)
src/Groups/libraries/transitivegroups.jl 91.30% <ø> (ø)
... and 11 more

@wbhart wbhart merged commit 8e029a0 into oscar-system:master Oct 27, 2020
@rfourquet rfourquet deleted the rf/docstring-format branch October 27, 2020 16:21
@rfourquet rfourquet changed the title fix "docstring odditites" fix "docstring oddities" Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants