Skip to content

Commit

Permalink
rewording and adding more links
Browse files Browse the repository at this point in the history
  • Loading branch information
HGWright committed Dec 22, 2023
1 parent 4a827ea commit f611082
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
15 changes: 8 additions & 7 deletions docs/src/userguide/citation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ Citing Iris
If Iris played an important part in your research then please add us to your
reference list by using the recommendations below.

IRIS can be cited directly from the `GitHub repository. <https://github.com/SciTools/iris>`_
Iris can be cited directly from the `GitHub repository <https://github.com/SciTools/iris>`_
, for more information including where to find the citation on the repo please
see the `GitHub documentation`_.

The IRIS citation does not contain the version of the software used. We
The Iris citation does not contain the version of the software used. We
recommend that you use the version number of the release you used, and the
commit hash of the version you used. This will allow others to reproduce the
environment that you worked in.
commit hash if you checked out a unreleased version of Iris. This will allow
others to reproduce the environment that you worked in. You can see what a
citation should look like for a particular version of Iris, on the `GitHub documentation`_.

You can find what a citation should look like for a particular version of IRIS,
and where to find the citation on GitHub by looking at the `documentation GitHub
has for citing repositories. <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files>`_
.. _GitHub documentation: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files/
4 changes: 2 additions & 2 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ This document explains the changes made to Iris for this release
#. `@lbdreyer`_ relicensed Iris from LGPL-3 to BSD-3. (:pull: `5577`)

#. `@HGWright`_, `@bjlittle`_ and `@trexfeathers`_ (reviewers) added a
CITATION.cff file to Iris and updated the citation documentation, to help
users cite Iris in their work. (:pull:`5483`)
CITATION.cff file to Iris and updated the :ref:`citation documentation <Citing_Iris>`
, to help users cite Iris in their work. (:pull:`5483`)


✨ Features
Expand Down

0 comments on commit f611082

Please sign in to comment.