Skip to content

Commit c52e9b3

Browse files
thodson-usgsclaude
andcommitted
docs: correct accuracy gaps in installation and contributing guides
- installing.rst: fix the conda command (`conda install -c conda-forge dataretrieval`, not `conda -c conda-forge install ...`). - contributing.rst: the package version is derived from Git tags by setuptools_scm, so the "edit the version in setup.py / conf.py" steps are obsolete — replace them with the tag-based release note. Bump the supported Python from "3.6, 3.7, 3.8" to "3.9 and later" (matches pyproject `requires-python` and the CI matrix: 3.9/3.13/3.14). - CONTRIBUTING.md: update stale `USGS-python/dataretrieval` issue URLs to `DOI-USGS/dataretrieval-python`, `blob/master` -> `blob/main`, the Python version list to "3.9 and later", and fix an "interace" typo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent be0f072 commit c52e9b3

3 files changed

Lines changed: 17 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ however writing code is not the only way to contribute.
3636

3737
### Reporting Bugs
3838

39-
Report bugs at https://github.com/USGS-python/dataretrieval/issues.
39+
Report bugs at https://github.com/DOI-USGS/dataretrieval-python/issues.
4040

4141
When reporting a bug, please include:
4242

@@ -49,7 +49,7 @@ When reporting a bug, please include:
4949

5050
### Fixing Bugs
5151

52-
Look through the GitHub [issues](https://github.com/USGS-python/dataretrieval/issues)
52+
Look through the GitHub [issues](https://github.com/DOI-USGS/dataretrieval-python/issues)
5353
for known and unresolved bugs. Any issues labeled "bug" that are unassigned,
5454
are open for resolution. You are welcome to comment in the relevant issue to
5555
state your intention to resolve the bug, which will help ensure there is no
@@ -68,7 +68,7 @@ your fork, to the original upstream repository.
6868

6969
### Implementing Features
7070

71-
Look through the GitHub [issues](https://github.com/USGS-python/dataretrieval/issues)
71+
Look through the GitHub [issues](https://github.com/DOI-USGS/dataretrieval-python/issues)
7272
for outstanding feature requests. Anything tagged with "enhancement"
7373
and "please-help" is open to whomever wants to implement it.
7474

@@ -83,8 +83,8 @@ Before you submit a pull request, check that it meets these guidelines:
8383
2. If the pull request adds or modifies functionality, the documentation should
8484
be updated. To do so, either add or modify a functions docstring which will
8585
automatically become part of the API documentation
86-
3. The pull request should work for Python 3.7, 3.8, 3.9, 3.10 - refer to the
87-
[python-package.yml file](https://github.com/USGS-python/dataretrieval/blob/master/.github/workflows/python-package.yml)
86+
3. The pull request should work for Python 3.9 and later - refer to the
87+
[python-package.yml file](https://github.com/DOI-USGS/dataretrieval-python/blob/main/.github/workflows/python-package.yml)
8888
for the latest versions of Python being tested by the continuous integration
8989
pipelines. This will be checked automatically by the CI pipelines once the
9090
pull request is opened.
@@ -98,7 +98,7 @@ via any automated processes or pipelines.
9898
#### Style
9999

100100
* Attempt to write code following the [PEP8 style guidelines](https://peps.python.org/pep-0008/) as much as possible
101-
* The public interace should emphasize functions over classes; however, classes
101+
* The public interface should emphasize functions over classes; however, classes
102102
can and should be used internally and in tests
103103
* Functions for downloading data from a specific web portal must be grouped
104104
within their own submodule
@@ -202,7 +202,7 @@ will need to do the following (in a separate branch of the repository):
202202
### Submitting Feedback
203203

204204
The best way to send feedback is to open an issue at
205-
https://github.com/USGS-python/dataretrieval/issues.
205+
https://github.com/DOI-USGS/dataretrieval-python/issues.
206206

207207
Please be as clear as possible in your feedback, if you are reporting a bug
208208
refer to [Reporting Bugs](#reporting-bugs).
@@ -211,7 +211,7 @@ refer to [Reporting Bugs](#reporting-bugs).
211211
### Feature Requests
212212

213213
To request or propose a new feature, open an issue at
214-
https://github.com/USGS-python/dataretrieval/issues.
214+
https://github.com/DOI-USGS/dataretrieval-python/issues.
215215

216216
Please be sure to:
217217
* Explain in detail how it would work, possibly with pseudo-code or an example

docs/source/meta/contributing.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,24 +64,25 @@ Before you submit a pull request, check that it meets these guidelines:
6464
2. If the pull request adds functionality, the docs should be updated. Put
6565
your new functionality into a function with a docstring, and add the
6666
feature to the list in README.md.
67-
3. The pull request should work for Python 3.6, 3.7, 3.8, and pass the GitHub
67+
3. The pull request should work for Python 3.9 and later, and pass the GitHub
6868
Actions continuous integration pipelines.
6969

7070

7171
Updating Package Version:
72-
^^^^^^^^^^^^^^^^^^^^^^^^^
72+
^^^^^^^^^^^^^^^^^^^^^^^^^^
7373

7474
Follow semantic versioning as best as possible. This means that changing the
7575
first digit of the version indicates a breaking change. Any smaller changes
7676
should attempt to maintain backwards-compatibility with previous code and
7777
issue deprecation warnings for features or functionality that will be removed
7878
or no longer be backwards-compatible in future releases.
7979

80-
When updating the package version, there are currently two places where this
81-
must be done:
82-
83-
1. In the `setup.py` file the version field should be updated
84-
2. In the `conf.py` file both the version and release fields can be updated
80+
The package version is derived automatically from Git tags by
81+
``setuptools_scm`` (see ``[tool.setuptools_scm]`` in ``pyproject.toml``), so
82+
there is no version string to edit by hand. To cut a release, tag the commit
83+
(for example, ``git tag v1.2.3``) and push the tag; both the installed package
84+
version and the documentation's ``version`` and ``release`` values (read via
85+
``importlib.metadata`` in ``docs/source/conf.py``) follow from it.
8586

8687

8788
Coding Standards

docs/source/meta/installing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To install the latest stable release of ``dataretrieval`` from the
3030

3131
.. code-block:: bash
3232
33-
$ conda -c conda-forge install dataretrieval
33+
$ conda install -c conda-forge dataretrieval
3434
3535
.. _conda-forge channel: https://anaconda.org/conda-forge/dataretrieval
3636

0 commit comments

Comments
 (0)