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

docs: improve introductory tutorial #2087

Merged
merged 1 commit into from
Mar 31, 2024
Merged

Conversation

puer-robustus
Copy link
Contributor

This fixes

  • some minor grammatical errors,
  • an incorrect header indentation level,

and also starts using the standard markdown footnote syntax. Since the latter is a bit of a bigger change (footnotes go to the end of the page), I put it in a separate commit. We could also consider using footnotes for the two scientific quotations, if so desired.

@puer-robustus puer-robustus marked this pull request as ready for review March 24, 2024 11:31
@EwoutH EwoutH added the docs Release notes label label Mar 24, 2024
Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

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

Thanks, good catches!

Can this PR be merged or do you want to make other changes?

@puer-robustus
Copy link
Contributor Author

puer-robustus commented Mar 24, 2024

Depends on what your take on the two scientific references in the intro is. I have no strong preference (footnotes vs. keeping as is) either way.

@EwoutH
Copy link
Member

EwoutH commented Mar 24, 2024

Is this working as expected?

image

References as footnotes that refer to the full source at the bottom of the page sounds good.

@puer-robustus
Copy link
Contributor Author

puer-robustus commented Mar 24, 2024

Hmm, no, actually I'd have expected something like that:

20240324_14h53m52s_grim

As far as I can tell, this is also what it looks like in the readthedocs build for the PR.

@EwoutH
Copy link
Member

EwoutH commented Mar 24, 2024

Yes, that's nice. Can we create a solution that also looks nice in the Jupyter notebook?

@puer-robustus
Copy link
Contributor Author

puer-robustus commented Mar 24, 2024

Only by adding the jupyterlab_myst dependency to the jupyter executable with which you're opening the .ipynb file. Then the footnote will look like this:

20240324_18h04m38s_grim

The footnote text will only show up by hovering over the [2] link in the example above.

@EwoutH
Copy link
Member

EwoutH commented Mar 24, 2024

Maybe in that case I prefer a direct link to the papers (just [text](url)).

@puer-robustus
Copy link
Contributor Author

Maybe in that case I prefer a direct link to the papers (just [text](url)).

That's a good idea for the papers: will adapt the tutorial accordingly.

What about the footnotes detailing the Grids and providing background info on pandas? Do we keep them as they are now (*) or with the footnote syntax introduced in this PR (nicer docs website but slightly more convoluted notebook looks)?

@EwoutH
Copy link
Member

EwoutH commented Mar 24, 2024

Both ways are fine I think, I slightly prefer the readability of the notebooks over the docs, since they are mainly interactive tutorials.

Fixes typos and header level error.
@puer-robustus
Copy link
Contributor Author

I've removed the footnote syntax changes (but kept some formatting corrections in the footnote text).

Maybe in that case I prefer a direct link to the papers (just text).

I've reconsidered here: Do we really want to do that? I think a reference as it currently stands is not so bad and provides more info than a simple URL could. I'd suggest to just keep those citations as is today.

@puer-robustus
Copy link
Contributor Author

@EwoutH Is there anything else you'd want me to change to get this merged?

Copy link
Member

@EwoutH EwoutH left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@EwoutH EwoutH merged commit 2c17631 into projectmesa:main Mar 31, 2024
12 checks passed
vitorfrois pushed a commit to vitorfrois/mesa that referenced this pull request Jul 15, 2024
…ojectmesa#2087)

This fixes
- some minor grammatical errors,
- an incorrect header indentation level,
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants