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

Improve figure docstrings and name #118

Closed
natema opened this issue Oct 12, 2022 · 8 comments
Closed

Improve figure docstrings and name #118

natema opened this issue Oct 12, 2022 · 8 comments
Labels
documentation Improvements or additions to documentation

Comments

@natema
Copy link
Member

natema commented Oct 12, 2022

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]):

WorldDynamics.World3.Agriculture.fig_69c
— Method

Reproduce Fig 4.69c. The original figure is presented on Chapter 4.

Also, we should consider changing the figure names to match the numbering in the book.

@natema natema added the documentation Improvements or additions to documentation label Oct 12, 2022
@natema natema changed the title Improve figure docstrings Improve figure docstrings and name Oct 12, 2022
@natema
Copy link
Member Author

natema commented Oct 13, 2022

@aurorarossi is also suggesting adding the original caption in the docstring.

@natema
Copy link
Member Author

natema commented Oct 13, 2022

A useful tip for testing the final result is to use LiveServer.jl to preview the documentation locally.

@paulobruno
Copy link
Collaborator

paulobruno commented Oct 13, 2022

Also, we should consider changing the figure names to match the numbering in the book.

What do you mean by "match the numbering in the book"? Aren't we are already following the same numbering?

@natema
Copy link
Member Author

natema commented Oct 13, 2022

What do you mean by "match the numbering in the book"? Aren't we are already following the same numbering?

E.g. Fig 7-7 is called fig_7 rather than fig_7_7.

@paulobruno
Copy link
Collaborator

E.g. Fig 7-7 is called fig_7 rather than fig_7_7.

Ok, I see. This was informally discussed with @piluc and we agreed that using, for example, World3.Agriculture.fig_4-69a is redundant, since Agriculture is always Chapter 4.

@natema
Copy link
Member Author

natema commented Oct 13, 2022

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.
E.g., we could define alias functions World3.fig_4_69a() = World3.Agriculture.fig_4-69a().
But I should have probably avoided mentioning this other point in this issue: the main one is to improve the docstrings.

@paulobruno
Copy link
Collaborator

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.

@paulobruno
Copy link
Collaborator

Fixed by #124

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants