Skip to content

Improve "How to Cite UXarray" docs page #1697

Description

@Sevans711

The "How to Cite UXarray" docs page currently insists upon a particular string format for text, and includes many fields which need to be edited manually:

UXarray Organization. (Year). UXarray (version <version>) [Software]. Project Raijin & Project SEATS. doi:10.5281/zenodo.<doi-part-per-version>.

Text like this could still be useful in some cases, but it may be much more convenient to provide the bibtex, since if you are using LaTeX it is hard (impossible?) to control the formatting of one citation in particular, and different academic journals may each prefer different formatting for references sections.

It might also be more useful to provide an updated, autofilled version of this string for the latest UXarray release (unless it is too challenging to implement that).

The next text on the page currently provides advice about how to cite all versions. My guess is that for most use cases, it would be more important to cite the version that was actually used, instead of all versions. I would suggest that the "citing a specific version" instructions should come before the "cite all versions" instructions. Either way, the page should provide at least some brief hint about when you might want to cite a specific version (e.g., if you ran uxarray code to generate your results, cite the version you used, or at least make sure to specify which version you used) versus citing all versions (e.g. maybe use this if you are writing a review paper about software packages and refer to the uxarray package).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status
    📝 To-Do

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions