Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Bland <tom_bland@hotmail.co.uk>
  • Loading branch information
dalonsoa and tsmbland authored Nov 7, 2024
1 parent 2186c7f commit 2e430bb
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To setup a virtual environment with all the requirements, navigate to Paricia's
python -m venv .venv
```

This will create an isolated Python environment within a directory called `.venv`. Notice that Paricia requires Python 3.11 or higher to work. Once the environment has been created, you can ativate it with:
This will create an isolated Python environment within a directory called `.venv`. Notice that Paricia requires Python 3.11 or higher to work. Once the environment has been created, you can activate it with:

```ps
.venv\Scripts\activate
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ This guide will help users of Paricia to get up to speed with its functionality

There are two types of Paricia users, those who are interested in exploring the data available - either registered users or not - and those who manage stations and want to create new entries in the database. The first group can just check the [Reporting](./reports.md) documentation, as it contains all the information they will need. The others should become familiar with all the pages of this user guide.

It should not be necessary to check the Developers documentation, but it might be helpful, occasionally, to have a look at the [Contributing guidelines](./contributing.md) if you spot something that doest not work as expected and you want to report it, and at the [Applications page](./Applications/index.md) where there are mode detailed descriptions of the models that make up Paricia.
It should not be necessary to check the Developers documentation, but it might be helpful, occasionally, to have a look at the [Contributing guidelines](./contributing.md) if you spot something that does not work as expected and you want to report it, and at the [Applications page](./Applications/index.md) where there are mode detailed descriptions of the models that make up Paricia.
4 changes: 2 additions & 2 deletions docs/quality_assurance.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Tests are created using the `unittest` framework. Read the [Testing in Django do

### Run selected tests

The above command will run all of the available tests. However, often - specially during debugging - you will want to run only specific tests. To do so, write the tests or group or tests that you want to run using the dot notation to indicate the path to the test:
The above command will run all of the available tests. However, often - especially during debugging - you will want to run only specific tests. To do so, write the tests or group or tests that you want to run using the dot notation to indicate the path to the test:

- Run a specific test, eg. `test_launch_reports_calculation`
```bash
Expand Down Expand Up @@ -51,4 +51,4 @@ Github workflows are set up to run the following automatically:

If any deployment of Paricia is watching for new versions in the registry, the new release might trigger an automated update of such deployment.

Additionally, Paricia repository is configured to receive automatic updagrades to packages and dependencies via `dependabot` and `pre-commit` bots. Periodically, they will open pull requests with the updated versions and, if the above checks are successful, they will be automatically merged. While sometimes manual intervention is necessary if the updated versions do not work, this process helps to keep Paricia up to date and simplifies the work of maintainers.
Additionally, the Paricia repository is configured to receive automatic upgrades to packages and dependencies via `dependabot` and `pre-commit` bots. Periodically, they will open pull requests with the updated versions and, if the above checks are successful, they will be automatically merged. While sometimes manual intervention is necessary if the updated versions do not work, this process helps to keep Paricia up to date and simplifies the work of maintainers.
2 changes: 1 addition & 1 deletion docs/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ In all cases, to go back to the full range, either use the tools in the top righ

## Missing spikes

The chosen approach for selecting the data to plot - just skipping points - is extremely fast as no data processing is required, but it has some drawbacks. In particular, as the display of the data skips a few points, the more points the highest the aggregation level, some features in the data might be lost.
The chosen approach for selecting the data to plot - just skipping points - is extremely fast as no data processing is required, but it has some drawbacks. In particular, as the display of the data skips a few points, the more points the higher the aggregation level, some features in the data might be lost.

For example, if we zoom in the first part of the series, we can see some - most likely wrong - data points shooting up to 50. These were not visible in the general view.

Expand Down

0 comments on commit 2e430bb

Please sign in to comment.