-
Notifications
You must be signed in to change notification settings - Fork 52
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
docs: fix typos #304
docs: fix typos #304
Conversation
Other things can be harmonized as well, e.g. the use of
The other (five) instances (just) use the normal math |
Thanks! |
What I have also noticed is that you (sometimes) write "personal names" in small letters like "antonine"
or "helmholtz" Clapeyron.jl/docs/src/properties/basic.md Line 19 in 529af13
Is that on purpose? |
|
Ok, one more thing I have noticed. Have a look at the items in https://clapeyronthermo.github.io/Clapeyron.jl/dev/user_guide/custom_methods/#Definitions which is the output of Clapeyron.jl/docs/src/user_guide/custom_methods.md Lines 8 to 10 in 529af13
I am guessing that the starts of the lines should look something similar to [`volume(model, p, T, z)`](@ref) right? But I don't have a clue if this gives the expected result. |
i just checked the docs for Documenter.jl, and the correct syntax for those cases is actually:
https://documenter.juliadocs.org/stable/man/syntax/#Named-@refs |
I'd say this is something for another PR which I leave up for you, just in case this doesn't work (directly). Are you fine with that? |
yeah, i will test if that works later. in the meantime, i think this PR is ready to merge. |
Mind if I take a look before merging? |
Sure, but since I just forked the master branch it would be nice to first merge this PR. After that I'll refork and have a look. Shall I start a discussion for general things about the docs or what would be a proper place for that? |
Done! Discussion would probably be the best place for it. |
and improve some formatting/style.