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

Add initial page for important myst syntax. #542

Merged

Conversation

MFraters
Copy link
Member

This add a page to the developer documentation on the important syntax for writing documentation in issue #532.

I think it is almost done, but I may need to add a few more syntax elements.

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d465a69) 93.49% compared to head (bb40640) 93.54%.
Report is 27 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #542      +/-   ##
==========================================
+ Coverage   93.49%   93.54%   +0.05%     
==========================================
  Files          92       92              
  Lines        6346     6340       -6     
==========================================
- Hits         5933     5931       -2     
+ Misses        413      409       -4     

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

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

Copy link

github-actions bot commented Feb 13, 2024

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.023 ± 0.004 (s=460) 1.024 ± 0.005 (s=422) -0.0% .. +0.1%
Slab interpolation curved simple none 1.026 ± 0.003 (s=481) 1.025 ± 0.003 (s=399) -0.1% .. +0.0%
Spherical slab interpolation simple none 1.259 ± 0.005 (s=360) 1.258 ± 0.003 (s=358) -0.1% .. +0.0%
Slab interpolation simple curved CMS 1.054 ± 0.011 (s=426) 1.054 ± 0.011 (s=430) -0.3% .. +0.2%
Spherical slab interpolation simple CMS 1.862 ± 0.007 (s=251) 1.860 ± 0.005 (s=235) -0.2% .. +0.0%
Spherical fault interpolation simple none 1.272 ± 0.004 (s=354) 1.271 ± 0.005 (s=356) -0.1% .. +0.0%
Cartesian min max surface 2.361 ± 0.017 (s=191) 2.363 ± 0.020 (s=193) -0.2% .. +0.4%
Spherical min max surface 7.358 ± 0.016 (s=55) 7.352 ± 0.018 (s=70) -0.2% .. +0.1%

@MFraters MFraters force-pushed the dev_doc_important_myst_syntax branch from 58824b5 to 9ba01b9 Compare February 13, 2024 17:45
@MFraters MFraters force-pushed the dev_doc_important_myst_syntax branch from 9ba01b9 to 69364d1 Compare February 13, 2024 17:50
@MFraters MFraters changed the title [WIP] Add initial page for important myst syntax. Add initial page for important myst syntax. Feb 13, 2024
Copy link
Contributor

@gassmoeller gassmoeller left a comment

Choose a reason for hiding this comment

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

Just a few small comments. Fix them then this is good to go.

PAGES = {1785--1807},
URL = {https://se.copernicus.org/articles/10/1785/2019/},
DOI = {10.5194/se-10-1785-2019}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

missing newline at end of file

Comment on lines 331 to 334
- `firstauthor:secondauthor:year` for two authors
- `firstauthor:secondauthor:year` for three authors
- `firstauthor:secondauthor:etal:year` for more than two authors
Copy link
Contributor

Choose a reason for hiding this comment

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

this format is different from your current format. Want to update?

MFraters and others added 2 commits February 13, 2024 20:21
Co-authored-by: Rene Gassmoeller <rene.gassmoeller@mailbox.org>
@MFraters MFraters merged commit ed97ffb into GeodynamicWorldBuilder:main Feb 13, 2024
33 of 34 checks passed
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