Skip to content

improved docs for core.Grid#106

Merged
orbeckst merged 3 commits intomasterfrom
doc-properties
Feb 21, 2022
Merged

improved docs for core.Grid#106
orbeckst merged 3 commits intomasterfrom
doc-properties

Conversation

@orbeckst
Copy link
Copy Markdown
Member

- fix #69
- document all public attributes
- various text/syntax fixes
- fixed docs for MRC
- added forgotten import of `mrc` to core/__init__.py
- update CHANGELOG
@pep8speaks
Copy link
Copy Markdown

pep8speaks commented Feb 20, 2022

Hello @orbeckst! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 705:80: E501 line too long (83 > 79 characters)
Line 744:80: E501 line too long (80 > 79 characters)

Comment last updated at 2022-02-21 05:03:35 UTC

@orbeckst orbeckst requested a review from IAlibay February 20, 2022 22:36
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 20, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.08%. Comparing base (3129570) to head (683b9f7).
Report is 32 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #106      +/-   ##
==========================================
+ Coverage   88.07%   88.08%   +0.01%     
==========================================
  Files           6        6              
  Lines         855      856       +1     
  Branches      146      146              
==========================================
+ Hits          753      754       +1     
  Misses         60       60              
  Partials       42       42              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@orbeckst orbeckst mentioned this pull request Feb 20, 2022
@orbeckst
Copy link
Copy Markdown
Member Author

Sorry, I don't know why RTD does not show up as a status check.

@IAlibay
Copy link
Copy Markdown
Member

IAlibay commented Feb 20, 2022

Just going to cycle the PR, sometimes "close and open" is enough to trigger webhooks.

@IAlibay IAlibay closed this Feb 20, 2022
@IAlibay IAlibay reopened this Feb 20, 2022
@IAlibay
Copy link
Copy Markdown
Member

IAlibay commented Feb 20, 2022

There we go (unless @orbeckst did something in the background and "have you turned it on and off again" was just good timing :P )

Copy link
Copy Markdown
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks! (couple of comments but nothing blocking)

- applied @IAlibay's suggestions
- add docs for core.Grid.midpoints
@orbeckst orbeckst self-assigned this Feb 21, 2022
@orbeckst orbeckst merged commit eba0d8e into master Feb 21, 2022
@orbeckst orbeckst deleted the doc-properties branch February 21, 2022 05:12
@orbeckst
Copy link
Copy Markdown
Member Author

thanks for the quick turnaround @IAlibay

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.

Incomplete documentation for properties

3 participants