Add plotting section to README #3
Conversation
Added a section on plotting to the README.
There was a problem hiding this comment.
Pull request overview
This PR adds a new "Plotting" section to the README to document the library's visualization capabilities.
- Adds a new section documenting the plotting/visualization features
- Brief description of the library's ability to visualize simulation results
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
|
|
||
| ## Plotting | ||
|
|
||
| The library has the facility to visualize simulation results, in a variety of colors. |
There was a problem hiding this comment.
Use British English spelling: "visualise" instead of "visualize" and "colours" instead of "colors". The codebase consistently uses British spelling, as seen in the module name visualise.py.
| The library has the facility to visualize simulation results, in a variety of colors. | |
| The library has the facility to visualise simulation results, in a variety of colours. |
Updated spelling of 'visualize' to 'visualise' and added note on British English usage.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 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. |
There was a problem hiding this comment.
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.
| 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`). |
|
|
||
| ## Contributor guide | ||
|
|
||
| NB Throughout we use British english except for the word color, this is important to remember. |
There was a problem hiding this comment.
The word "english" should be capitalized to "English" as it refers to the English language.
| 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. |
|
|
||
| ## Plotting | ||
|
|
||
| The library has the facility to visualise simulation results, in a variety of colors. |
There was a problem hiding this comment.
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.
| 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. |
Added a section on plotting to the README.