Skip to content

Commit

Permalink
fix(docs): throw in some typo fixes
Browse files Browse the repository at this point in the history
Signed-off-by: F.N. Claessen <[email protected]>
  • Loading branch information
Flix6x committed Nov 7, 2023
1 parent 3cdb05c commit 94e286f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ For information, read and make sure you're okay with the [Contributing guideline
- [ ] Add the "master / nothing to see here" in Changelog.md
- [ ] Push & wait for the tests to be green
- [ ] Merge --ff
- Github stuff
- GitHub stuff
- [ ] Push tag in Github
- [ ] Edit release on Github using the changelog.
- [ ] Edit release on GitHub using the changelog.
- [ ] Delete branch
- [ ] upload release on PyPI using ``twine``
- [ ] (*optional*) Make feeback on the various PR or issues.
- [ ] (*optional*) Make feedback on the various PR or issues.
-->
8 changes: 4 additions & 4 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

- Update China's public holidays for 2023 (#728).
- Removed compatibility with Python 3.6, also, removed tests & amended documentation (#705).
- Upgraded `tox` usage, now compatble with tox 4+ (added `allowlist_externals`).
- Upgraded `tox` usage, now compatible with tox 4+ (added `allowlist_externals`).
- Added support for Python 3.10 (#706).
- Added support for Python 3.11 (#732).
- Refactor ``NetherlandsWithSchoolHolidays.get_christmas_holidays`` for simplicity and readability.
Expand Down Expand Up @@ -186,7 +186,7 @@

### Other changes

- Switched from Travis CI to Github Actions for CI jobs, thanks to @mgu.
- Switched from Travis CI to GitHub Actions for CI jobs, thanks to @mgu.
- Added support of Python 3.9 (#557).
- Changed from `setup.py` to a nice `setup.cfg` file, thanks @ewjoachim (#576).
- Use the `setup.cfg` file in the key to cache in `ci.yml` file (#587).
Expand Down Expand Up @@ -624,7 +624,7 @@ Large work on global registry: refs #13, #96, #257 & #284.
- Added a `keep_datetime` option to keep the original type of the input argument for both ``add_working_days()`` and ``sub_working_days()`` functions (#270).
- Fixed usage examples of ``get_first_weekday_after()`` docstring + in code (calendars and tests) ; do not use magic values, use MON, TUE, etc (#271).
- Turned Changelog into a Markdown file (#272).
- Added basic usage documentation, hosted by Github pages.
- Added basic usage documentation, hosted by GitHub pages.
- Added advanced usage documentation.

## v2.5.0 (2018-06-14)
Expand Down Expand Up @@ -667,7 +667,7 @@ I have done a terrible mistake with the 1.3.0 release, and uploaded a defunct 2.

## v2.0.0 (2017-06-23)

- Major refactor in the USA module. Each State is now an independant module, all of the Mixins were removed, all the possible corrections have been made, following the main Wikipedia page, and cross-checking with official sources when it was possible (#171).
- Major refactor in the USA module. Each State is now an independent module, all of the Mixins were removed, all the possible corrections have been made, following the main Wikipedia page, and cross-checking with official sources when it was possible (#171).
- Added District of Columbia in the USA module (#217).
- Run tests with Python3.6 in CI (#210)
- Small refactors / cleanups in the following calendars: Hungary, Iceland, Ireland, Latvia, Netherlands, Spain, Japan, Taiwan, Australia, Canada, USA (#209).
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

If you are using `workalendar`, you are already contributing to it. As long as you are able to check its result, compare the designated working days and holidays to the reality, and make sure these are right, you're helping.

If any of the computed holidays for the country / area your are using is **wrong**, please report [it using the Github issues](https://github.com/workalendar/workalendar/issues).
If any of the computed holidays for the country / area you are using is **wrong**, please report [it using the Github issues](https://github.com/workalendar/workalendar/issues).

## Report an issue

Expand Down Expand Up @@ -56,7 +56,7 @@ Here is a list of the holidays in *Zhraa*:

#### Getting ready

You'll need to install `workalendar` dependencies beforehand. What's great is that you'll use virtualenv to set it up. Or even better: `virtualenvwrapper`. Just go in your working copy (cloned from github) of workalendar and type, for example:
You'll need to install `workalendar` dependencies beforehand. What's great is that you'll use virtualenv to set it up. Or even better: `virtualenvwrapper`. Just go in your working copy (cloned from GitHub) of workalendar and type, for example:

```sh
mkvirtualenv WORKALENDAR
Expand Down

0 comments on commit 94e286f

Please sign in to comment.