Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small adjustments to the installation instructions #50

Merged
merged 8 commits into from
Jun 14, 2024
Merged

Conversation

RondeauG
Copy link

What kind of change does this PR introduce?

  • Small adjustments to the installation instructions.
  • Fixed bad spacing that broke the numbering.

Does this PR introduce a breaking change?

Other information:

@RondeauG RondeauG requested a review from Zeitsperre June 14, 2024 18:39
@@ -24,20 +24,21 @@ From sources

The sources for {{ cookiecutter.project_name }} can be downloaded from the `Github repo <{{ cookiecutter.__gh_slug}}>`_.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want an Anaconda version of this file.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. What we can do is stage it via commented out rst code here:

..

    Some direction Anaconda directions:

    .. code:: shell

        $ ...

@RondeauG RondeauG changed the title Installdoc Small adjustments to the installation instructions Jun 14, 2024
Copy link

@Zeitsperre Zeitsperre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

{{cookiecutter.project_slug}}/CONTRIBUTING.rst Outdated Show resolved Hide resolved
{{cookiecutter.project_slug}}/CONTRIBUTING.rst Outdated Show resolved Hide resolved
{{cookiecutter.project_slug}}/CONTRIBUTING.rst Outdated Show resolved Hide resolved
{{cookiecutter.project_slug}}/CONTRIBUTING.rst Outdated Show resolved Hide resolved
{{cookiecutter.project_slug}}/docs/installation.rst Outdated Show resolved Hide resolved
Co-authored-by: Trevor James Smith <[email protected]>
@RondeauG RondeauG merged commit 7768d8b into main Jun 14, 2024
6 checks passed
@RondeauG RondeauG deleted the installdoc branch June 14, 2024 19:26
Zeitsperre added a commit to hydrologie/xdatasets that referenced this pull request Jul 4, 2024
### What kind of change does this PR introduce?

* Updates the cookiecutter to the latest commit.
* The `ruff` linter has been adjusted to render the `flake8-alphabetize`
dependency redundant (and removed).
* Several `noqa` and `fixme` statements have been added to pass
additional linting checks for now.

### Does this PR introduce a breaking change?

Yes. 
* The structure of the package is slightly modified from a flat layout
to a src layout.
(https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/)
* `CHANGES.rst` is now `CHANGELOG.rst`.
(https://keepachangelog.com/en/1.1.0/#frequently-asked-questions)
* Bumping a release version will trigger changes in the `CHANGELOG.rst`
file. (Ouranosinc/cookiecutter-pypackage#41)

### Other information:

~This does not yet integrate changes from
Ouranosinc/cookiecutter-pypackage#50 (but it
should before merging)~

We should perform a release after this and then see about proposing the
package to `conda-forge`!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants