-
Notifications
You must be signed in to change notification settings - Fork 6
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
Improve figure docstrings and name #118
Comments
@aurorarossi is also suggesting adding the original caption in the docstring. |
A useful tip for testing the final result is to use LiveServer.jl to preview the documentation locally. |
What do you mean by "match the numbering in the book"? Aren't we are already following the same numbering? |
E.g. |
Ok, I see. This was informally discussed with @piluc and we agreed that using, for example, |
I agree, and the if the reader doesn't know that fact and open the book and wants to reproduce figure 4-69a, they can still find the command in the documentation, but I'm wondering if we could make it a bit more user friendly with little effort. |
Ok, so my suggestion is to use this issue only for the docstrings, without changing the names. Then we can start a discussion about the "alias" functions. |
Fixed by #124 |
The current docstrings reference a chapter without referring to a specific book.
With the current plan to add more models, it would be better to mention the book explicitly, possibly as a linked acronym ([DGFW]):
Also, we should consider changing the figure names to match the numbering in the book.
The text was updated successfully, but these errors were encountered: