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

Documentation tweaks #852

Merged
merged 11 commits into from Jun 18, 2021
Merged

Documentation tweaks #852

merged 11 commits into from Jun 18, 2021

Conversation

JPBergsma
Copy link
Contributor

Processed the suggestion I made for PR #850

Processed my suggestions for the text added by 'PR #850 Add some more tutorial-style documentation'.
@codecov
Copy link

codecov bot commented Jun 15, 2021

Codecov Report

Merging #852 (fc32d19) into master (bd91f13) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #852   +/-   ##
=======================================
  Coverage   92.64%   92.64%           
=======================================
  Files          67       67           
  Lines        3724     3724           
=======================================
  Hits         3450     3450           
  Misses        274      274           
Flag Coverage Δ
project 92.64% <ø> (ø)
validator 92.64% <ø> (ø)

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

Impacted Files Coverage Δ
optimade/validator/__init__.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd91f13...fc32d19. Read the comment docs.

Copy link
Member

@CasperWA CasperWA left a comment

Choose a reason for hiding this comment

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

Cheers :) Just a few suggested changes and ideas below.

docs/getting_started/filtering.md Outdated Show resolved Hide resolved
docs/getting_started/filtering.md Outdated Show resolved Hide resolved
docs/getting_started/filtering.md Outdated Show resolved Hide resolved
docs/getting_started/validation.md Outdated Show resolved Hide resolved
JPBergsma and others added 3 commits June 16, 2021 13:01
added suggestions CasperW which add references to API documentation.

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
docs/getting_started/filtering.md Outdated Show resolved Hide resolved
docs/getting_started/filtering.md Outdated Show resolved Hide resolved
docs/getting_started/validation.md Outdated Show resolved Hide resolved
optimade/validator/__init__.py Outdated Show resolved Hide resolved
JPBergsma and others added 4 commits June 16, 2021 16:13
Removed superfluous single quotes.

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
@JPBergsma JPBergsma requested a review from CasperWA June 17, 2021 09:37
docs/getting_started/validation.md Outdated Show resolved Hide resolved
optimade/validator/__init__.py Outdated Show resolved Hide resolved
JPBergsma and others added 2 commits June 17, 2021 15:50
Accepted minor changes from code suggestions

Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
@ml-evs ml-evs changed the title Jp bergsma/remarks pr #850 Documentation tweaks Jun 18, 2021
Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

This LGTM now, thanks @JPBergsma

@JPBergsma JPBergsma requested a review from CasperWA June 18, 2021 10:39
Copy link
Member

@CasperWA CasperWA left a comment

Choose a reason for hiding this comment

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

Cheers @JPBergsma

@CasperWA CasperWA merged commit a4d3424 into master Jun 18, 2021
@CasperWA CasperWA deleted the JPBergsma/Remarks_PR_#850 branch June 18, 2021 13:23
@JPBergsma
Copy link
Contributor Author

Thanks for merging this PR, my first accepted PR for Optimade!
I hope next one will follow soon.

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.

None yet

3 participants