Skip to content

Add CITATION.cff#573

Merged
dweindl merged 4 commits intomainfrom
cit_cff
Dec 12, 2023
Merged

Add CITATION.cff#573
dweindl merged 4 commits intomainfrom
cit_cff

Conversation

@dweindl
Copy link
Copy Markdown
Member

@dweindl dweindl commented Dec 11, 2023

Closes #572

@dweindl dweindl requested a review from a team as a code owner December 11, 2023 12:41
Copy link
Copy Markdown
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

Looks fine to me.

  • could add a URL to the publication, but the DOI suffices
  • could add a license, though I guess it's irrelevant for a citation
  • I can't see a link to the paper in the README. Could move the "How to cite" section of the docs to the README, or mention the paper in the README somewhere
  • Is the "How to cite" section redundant or complementary to this?

Comment thread CITATION.cff
Comment thread CITATION.cff
Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
@dweindl
Copy link
Copy Markdown
Member Author

dweindl commented Dec 12, 2023

* could add a URL to the publication, but the DOI suffices

GitHub automatically converts the doi to an URL, so I think that's fine.

* could add a license, though I guess it's irrelevant for a citation

will do.

* I can't see a link to the paper in the README. Could move the "How to cite" section of the docs to the README, or mention the paper in the README somewhere
* Is the "How to cite" section redundant or complementary to this?

I think it's good to have it somewhere on the RTD page, but the README itself doesn't really need it.

@dweindl dweindl merged commit 10e573e into main Dec 12, 2023
@dweindl dweindl deleted the cit_cff branch December 12, 2023 14:48
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.

No reference to paper in repository

2 participants