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

Update Schelling Readme.md #2406

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Conversation

quaquel
Copy link
Member

@quaquel quaquel commented Oct 23, 2024

This updates the Schelling readme. It has the correct file names for all files. It also removes the text on requirements.txt since this file is not included.

@quaquel quaquel added the docs Release notes label label Oct 23, 2024
@jackiekazil
Copy link
Member

This works. We have a pattern of having an installation section in the readme though -- I think we should keep that pattern.
Someone might not know they need to add mesa to their environment -- they might try to pip install from pypi, which wouldn't work with the example necessarily. I think we should have this in all the examples. Thoughts?

This was referenced Oct 24, 2024
@quaquel
Copy link
Member Author

quaquel commented Oct 24, 2024

This works. We have a pattern of having an installation section in the readme though -- I think we should keep that pattern.
Someone might not know they need to add mesa to their environment -- they might try to pip install from pypi, which wouldn't work with the example necessarily. I think we should have this in all the examples. Thoughts?

My concern with adding it to the readme's for all examples is the same as my concern with requirements.txt in all examples. It results in duplication of text, which is easy to miss and annoying to maintain. I agree, however, that it would be good to be clear somewhere that these examples ship with mesa and require mesa to be installed.

Looking at the current docs, I noticed that Using Mesa on the landing page covers installing mesa, but also showcases how to run an example. First, this example is outdated and needs to be removed. Might it be a solution to update this text using one of the basic examples? We could then add a link here also to the TOC for all examples that ship with mesa.

Alternatively, what about including some additional text in the TOC for examples? It would be easy to add a paragraph at the top with installation instructions and run instructions that is valid for all examples.

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.

One minor nitpick, otherwise good!

mesa/examples/basic/schelling/Readme.md Outdated Show resolved Hide resolved
@quaquel
Copy link
Member Author

quaquel commented Oct 24, 2024

@jackiekazil I am merging these PRs and will add your point on installation instructions to the tracking issue. My current inclination is to address it at the level of the TOC for all examples. This page needs work anyway because it should be tied to the readme at the root of the examples folder.

@quaquel quaquel merged commit 91b8047 into projectmesa:main Oct 24, 2024
2 checks passed
@quaquel quaquel deleted the schelling_readme branch October 25, 2024 06:02
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.

3 participants