Skip to content

Commit

Permalink
Merge pull request projectmesa#999 from EdwardBetts/spelling
Browse files Browse the repository at this point in the history
Correct spelling
  • Loading branch information
jackiekazil authored Feb 28, 2021
2 parents eb1ba9d + 7d11d48 commit d907d3b
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ We test by implementing simple models and through traditional unit tests in the
py.test --cov=mesa tests/
With respect to code standards, we follow `PEP8`_ and the `Google Style Guide`_. We recommend to use `black`_ as an automated code formatter. You can automatically format your code using `pre-commit`_, which will prevent `git commit` of unstyled code and will automtically apply black style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:
With respect to code standards, we follow `PEP8`_ and the `Google Style Guide`_. We recommend to use `black`_ as an automated code formatter. You can automatically format your code using `pre-commit`_, which will prevent `git commit` of unstyled code and will automatically apply black style so you can immediately re-run `git commit`. To set up pre-commit run the following commands:

.. code-block:: bash
Expand Down
4 changes: 2 additions & 2 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -483,14 +483,14 @@ Theme: Scipy Sprints ( ‘-’)人(゚_゚ )
0.6.0 (2015-06-21)
++++++++++++++++++

* Improvment: Add modular server feature, which breaks up a model into a .py file and a .js file. This breaks backwards compatibility.
* Improvement: Add modular server feature, which breaks up a model into a .py file and a .js file. This breaks backwards compatibility.

Pre 0.6.0
++++++++++++++++++

Code that is pre-0.6.0 is very unstable.

Our inital release was 0.5.0 (2014-11).
Our initial release was 0.5.0 (2014-11).

It included code for placing agents on a grid; a data collector and batch runner; and a front-end visualization using HTML 5 and JavaScript.

Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ It's easy to create a cookiecutter mesa model by running ``mesa startproject``
Randomization
-------------

If your model involves some random choice, you can use the build-in ``random``
If your model involves some random choice, you can use the built-in ``random``
property that Mesa ``Model`` and ``Agent`` objects have. This works exactly
like the built-in ``random`` library.

Expand Down
2 changes: 1 addition & 1 deletion docs/modular-visualization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Using Pre-Built Modules

Mesa already comes with some pre-built modules. Using the built-ins
allow you to build a visualization without worrying about the HTML and
javascript. Consult the documention for a variety of modules.
javascript. Consult the documentation for a variety of modules.

One built-in module is **CanvasGrid**, which you can use to visualize
objects located on grid cells. The CanvasGrid will cover a majority of
Expand Down
4 changes: 2 additions & 2 deletions docs/packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This process isn't perfect. Just because you write something doesn't mean people

**What is in this doc**

There are two sections in this documention. The first is the User Guide, which is aimed at users of packages. The section is a package development guide, which is aimed at those who want to develop packages. Without further ado, let's get started!
There are two sections in this documentation. The first is the User Guide, which is aimed at users of packages. The section is a package development guide, which is aimed at those who want to develop packages. Without further ado, let's get started!


User Guide
Expand Down Expand Up @@ -120,7 +120,7 @@ References

Grimm, Volker, Eloy Revilla, Uta Berger, Florian Jeltsch, Wolf M. Mooij, Steven F. Railsback, Hans-Hermann Thulke, Jacob Weiner, Thorsten Wiegand, and Donald L. DeAngelis. 2005. “Pattern-Oriented Modeling of Agent Based Complex Systems: Lessons from Ecology.” American Association for the Advancement of Science 310 (5750): 987–91. doi:10.1126/science.1116681.

Hunt, Andrew, and David Thomas. 2010. The Pragmatic Progammer: From Journeyman to Master. Reading, Massachusetts: Addison-Wesley.
Hunt, Andrew, and David Thomas. 2010. The Pragmatic Programmer: From Journeyman to Master. Reading, Massachusetts: Addison-Wesley.

Leek, Jeffrey T., and Roger D. Peng. 2015. “Reproducible Research Can Still Be Wrong: Adopting a Prevention Approach.” Proceedings of the National Academy of Sciences 112 (6): 1645–46. doi:10.1073/pnas.1421412111.

4 changes: 2 additions & 2 deletions mesa/batchrunner.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def __init__(
agent_reporters: Like model_reporters, but each variable is now
collected at the level of each agent present in the model at
the end of the run.
display_progress: Display progresss bar with time estimation?
display_progress: Display progress bar with time estimation?
"""
self.model_cls = model_cls
Expand Down Expand Up @@ -362,7 +362,7 @@ def __init__(
Args:
model_cls: The class of model to batch-run.
variable_parameters: Dictionary of parameters to lists of values.
The model will be run with every combo of these paramters.
The model will be run with every combo of these parameters.
For example, given variable_parameters of
{"param_1": range(5),
"param_2": [1, 5, 10]}
Expand Down
4 changes: 2 additions & 2 deletions mesa/space.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class Grid:
get_neighborhood: Returns the cells surrounding a given cell.
get_cell_list_contents: Returns the contents of a list of cells
((x,y) tuples)
neighbor_iter: Iterates over position neightbors.
neighbor_iter: Iterates over position neighbours.
coord_iter: Returns coordinates as well as cell contents.
place_agent: Positions an agent on the grid, and set its pos variable.
move_agent: Moves an agent from its current position to a new position.
Expand Down Expand Up @@ -510,7 +510,7 @@ class HexGrid(Grid):
Methods:
get_neighbors: Returns the objects surrounding a given cell.
get_neighborhood: Returns the cells surrounding a given cell.
neighbor_iter: Iterates over position neightbors.
neighbor_iter: Iterates over position neighbours.
iter_neighborhood: Returns an iterator over cell coordinates that are
in the neighborhood of a certain point.
Expand Down

0 comments on commit d907d3b

Please sign in to comment.