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 Virus on Network documentation #100

Merged
merged 3 commits into from
Feb 22, 2024

Conversation

coderbeta1
Copy link
Contributor

Change 1: Make the ReadMe more descriptive

  1. Added a more detailed explanation of the model
  2. Added an extra method of running the model

Change 2: Doc Strings and Cleaning

Made small changes to make the code more readable and easy to understand at first glance

NOTE: In the model, after running, some of the nodes in the graph are isolated. In my opinion it should be connected (if it was intentional then fine but in case not it needs to be updated with a different graph creation technique)

@rht
Copy link
Contributor

rht commented Feb 19, 2024

@EwoutH
Copy link
Member

EwoutH commented Feb 19, 2024

pre-commit.ci autofix

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 for the PR, this is a valuable improvement to this example!

There is one minor issue with our formatter, once that's fixed it looks good to me to merge!

examples/virus_on_network/app.py Outdated Show resolved Hide resolved
@tpike3
Copy link
Member

tpike3 commented Feb 22, 2024

@coderbeta1 Welcome and thanks for the contribution!

This is a super minor fix, if you would prefer we can do it on our end, just let us know.

Thanks again

@EwoutH EwoutH changed the title Documentation improvement Improve Virus on Network documentation Feb 22, 2024
@EwoutH EwoutH merged commit 06c0015 into projectmesa:main Feb 22, 2024
3 checks passed
@EwoutH
Copy link
Member

EwoutH commented Feb 22, 2024

Merged, thanks for your contribution!

@coderbeta1 coderbeta1 deleted the virus_on_net branch February 22, 2024 18:18
@coderbeta1 coderbeta1 restored the virus_on_net branch February 23, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants