Skip to content

Commit

Permalink
Fix error in doc string and describe deployment better
Browse files Browse the repository at this point in the history
  • Loading branch information
aglavic committed Feb 23, 2024
1 parent b476a62 commit 18830f7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,11 @@ Pull Request Guidelines
Before you submit a pull request of your feature branch against the `main` branch of the `orsopy` repository,
check that it meets these guidelines:

2. If the pull request adds functionality, the docs should be updated. Put
1. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
1. The pull request should include tests for the new functionality. Run the tests in your local machine with `pytest`.
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. To make sure that the tests pass
2. The pull request should include tests for the new functionality. Run the tests in your local machine with `pytest`.
3. The pull request should work for Python 3.6, 3.7 and 3.8-latest, and for PyPy. To make sure that the tests pass
for all supported Python versions, you can first create a pull
request of your feature branch against the `main` branch _of your forked repository_. If the Github actions
pass, it is highly likely that the GitHub actions will also pass for the pull request against the `main` branch
Expand All @@ -140,13 +140,13 @@ $ pytest tests.test_orsopy
Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst)
and that the schema file was updated with tool/header_schema.py.
Then run::
A reminder for the maintainers on how to deploy:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
1. Update schema file using `python tool/header_schema.py`
2. Update version string in `orsopy/__init__.py`
3. Make sure all your changes are committed (including an entry in `HISTORY.rst`)
4. Tag the commit with `vX.Y.Z`
5. Push your changes to your fork (e.g. `release` branch)
6. Create a pull requrest including the label `release` and get reviewer approval

GitHub actions will then deploy to PyPI if tests pass.
2 changes: 1 addition & 1 deletion orsopy/fileio/data_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ class Measurement(Header):
:param instrument_settings: Instrumentation details.
:param data_files: Raw data files produced in the measurement.
:param references: Raw reference files used in the reduction.
:param additional_files: Raw reference files used in the reduction.
:param scheme: Measurement scheme (one of :code:`'angle-dispersive'`,
:code:`'energy-dispersive'`/:code:`'angle- and energy-dispersive'`).
"""
Expand Down

0 comments on commit 18830f7

Please sign in to comment.