Skip to content

Commit 2415e08

Browse files
committed
Shorten comments a little bit
1 parent f7e3979 commit 2415e08

1 file changed

Lines changed: 11 additions & 13 deletions

File tree

CITATION.cff

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
# Citation information for this repository. -*- yaml -*-
22
#
3-
# CITATION.cff files provide human- & machine-readable citation information for
4-
# software and datasets. GitHub, Zenodo, and the Zotero browser plugin all use
5-
# CFF files automatically if provided. https://citation-file-format.github.io/.
6-
#
7-
# Tools exist to generate CITATION.cff files from other formats such as BibTeX.
3+
# CITATION.cff provide human- & machine-readable citation info for software and
4+
# datasets. GitHub, Zenodo, and the Zotero browser plugin all use CFF files
5+
# automatically. Tools exist to generate CITATION.cff files from other formats
6+
# such as BibTeX. For more info, visit https://citation-file-format.github.io/.
87
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98

109
cff-version: 1.2.0
1110
message: If you use this software, please cite it using this metadata.
1211

1312
# CITATION.cff files describe how to cite software or datasets, with the goal of
14-
# making software and data be citable in their own right. However, sometimes
15-
# projects want citations to go to a paper instead. 'Preferred-citation' serves
16-
# to communicate that. The distinction matters in different situations. If this
17-
# field is present, GitHub uses the value for the "cite this repository" button
18-
# and ignores the rest of this file; conversely, the Zenodo-GitHub integration
19-
# ignores this field when creating an entry for a new software release (because
20-
# the Zenodo entry is specifically about the software in this repository).
13+
# making software and data be citable in their own right. However, some projects
14+
# prefer citations go to a paper instead. Preferred-citation communicates this.
15+
# It matters in different situations. If this field is present, GitHub uses the
16+
# value for the "cite this repository" button; conversely, the Zenodo-GitHub
17+
# integration ignores it when creating an entry for a new software release
18+
# (because the Zenodo entry is specifically about the software in this repo).
2119
preferred-citation:
2220
type: misc
2321
authors:
@@ -64,7 +62,7 @@ preferred-citation:
6462
keywords:
6563
- quant-ph
6664

67-
# The remaining metadata in this file describes the current software release.
65+
# The remaining metadata in this file describes software in this repository.
6866

6967
title: Qualtran
7068
authors:

0 commit comments

Comments
 (0)