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

Batch docstring formatting update: 'Examples:' -> 'Examples' #182

Conversation

sadielbartholomew
Copy link
Member

@sadielbartholomew sadielbartholomew commented Mar 22, 2022

Context provided in #168 (comment). Via the command find . -type f | xargs sed -i 's/Examples:/Examples/g', we go from:

$ git grep "Examples" | wc -l
501
$ git grep "Examples:" | wc -l
380

to:

$ git grep "Examples" | wc -l
501
$ git grep "Examples:" | wc -l
0

@sadielbartholomew sadielbartholomew added documentation Improvements or additions to documentation code tidy/refactor labels Mar 22, 2022
@sadielbartholomew sadielbartholomew self-assigned this Mar 22, 2022
@codecov
Copy link

codecov bot commented Mar 22, 2022

Codecov Report

Merging #182 (d1a5326) into master (1e1c74a) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #182      +/-   ##
==========================================
+ Coverage   87.39%   87.40%   +0.01%     
==========================================
  Files         122      122              
  Lines       12355    12355              
==========================================
+ Hits        10797    10798       +1     
+ Misses       1558     1557       -1     
Flag Coverage Δ
unittests 87.40% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cfdm/abstract/implementation.py 100.00% <ø> (ø)
cfdm/bounds.py 89.80% <ø> (ø)
cfdm/cellmeasure.py 84.38% <ø> (ø)
cfdm/cellmethod.py 88.74% <ø> (ø)
cfdm/cfdmimplementation.py 82.74% <ø> (ø)
cfdm/constructs.py 93.60% <ø> (ø)
cfdm/coordinatereference.py 89.93% <ø> (ø)
cfdm/core/abstract/container.py 100.00% <ø> (ø)
cfdm/core/abstract/coordinate.py 92.00% <ø> (ø)
cfdm/core/abstract/parameters.py 84.45% <ø> (ø)
... and 38 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@sadielbartholomew
Copy link
Member Author

sadielbartholomew commented Mar 22, 2022

Most of the CI jobs passed across two runs of the full set, but each time one or two test suite run jobs failed on a lone same test failure, which is clearly unrelated to this PR, though should be investigated relating to the outcome of recent PRs influencing the logic for subsampled coordinates:

======================================================================
FAIL: test_read_subsampled_coordinates (test_read_write.read_writeTest)
Test the reading subsampled coordinates.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/runner/work/cfdm/cfdm/cfdm/test/test_read_write.py", line 875, in test_read_subsampled_coordinates
    self.assertTrue(
AssertionError: False is not true

----------------------------------------------------------------------
Ran 229 tests in 208.518s

FAILED (failures=1, skipped=1)

This is therefore good to merge, and I will look into the above failure separately.

@sadielbartholomew sadielbartholomew merged commit a0bf44c into NCAS-CMS:master Mar 22, 2022
@sadielbartholomew sadielbartholomew deleted the examples-docstring-formatting branch March 22, 2022 02:49
@davidhassell
Copy link
Contributor

Thank you, Sadie!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code tidy/refactor documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants