Skip to content

Add plotting section to README #3

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.

Sign up for GitHub

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

Open
nickfyson wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add plotting section to README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b2f376
Add plotting section to README
nickfyson Dec 17, 2025
d0c2252
Correct spelling and add contributor guide note
nickfyson Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,12 @@ And for example usage see...

https://github.com/nickfyson/pyabolism/tree/master/examples


## Plotting

The library has the facility to visualise simulation results, in a variety of colors.
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

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

The word "colors" should use British spelling "colours" in documentation. While the codebase uses American spelling "color" when interfacing with matplotlib's API (e.g., 'facecolor', 'colors' as variable names), documentation prose should follow the British English convention established in this repository.

Suggested change
The library has the facility to visualise simulation results, in a variety of colors.
The library has the facility to visualise simulation results, in a variety of colours.

Copilot uses AI. Check for mistakes.


## Contributor guide

NB Throughout we use British english except for the word color, this is important to remember.
Comment on lines +17 to +22
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

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

This guideline about using American spelling for "color" is misleading and contradicts the established British English convention. The exception for "color" should only apply when using matplotlib API parameters and variable names (like 'facecolor', 'colors') in code, not in general documentation or comments. Consider clarifying that British spelling should be used in documentation and comments, with exceptions only for API compatibility in code.

Suggested change
The library has the facility to visualise simulation results, in a variety of colors.
## Contributor guide
NB Throughout we use British english except for the word color, this is important to remember.
The library has the facility to visualise simulation results, in a variety of colours.
## Contributor guide
NB Throughout we use British English in documentation and comments. Use "color" only when required for API compatibility in code (e.g. matplotlib keyword arguments such as `facecolor`, `colors`).

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

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

The word "english" should be capitalized to "English" as it refers to the English language.

Suggested change
NB Throughout we use British english except for the word color, this is important to remember.
NB Throughout we use British English except for the word color, this is important to remember.

Copilot uses AI. Check for mistakes.