Skip to content

Commit 25f9e63

Browse files
committed
chore: attempt to fix citation key error,
1 parent 245b226 commit 25f9e63

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

docs/content/contributing-guide.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ function follows the formatting specifications in [Code Style](#code-style). A s
175175
def my_new_function(some_parameter: parameter_type) -> return_type:
176176
r"""One liner description of the new function.
177177
178-
Detailed description of the function, citing relevant papers where appropriate [@johnston2014counting].
178+
Detailed description of the function, citing relevant papers where
179+
appropriate, for example: `[@johnston2014counting]`.
179180
180181
Examples:
181182
Demonstrate how the function works with expected output.
@@ -195,15 +196,16 @@ def my_new_function(some_parameter: parameter_type) -> return_type:
195196
"""
196197
```
197198

198-
Use `\(\)` for inline math and `\[\]` for display math in docstrings.
199-
Use `[@citation_key]` for citations in docstrings (e.g., `[@johnston2014counting]`).
199+
Use `\(\)` for inline math and `\[\]` for display math in docstrings. To cite an entry in `refs.bib`,
200+
use, for example, use <code>[johnston2014counting]</code> with an `@` before `johnston` to cite in the docstring.
200201

201202
To add an attribution to a paper or a book, add your reference with
202203
`some_ref` as the citation key to `docs/content/refs.bib`. All references in
203204
`refs.bib` are arranged alphabetically according to the first author's
204205
last name. Take a look at the [existing
205206
entries](https://github.com/vprusso/toqito/blob/master/docs/content/refs.bib) to
206207
get an idea of how to format the `bib` keys.
208+
207209
## Documentation
208210

209211
We use [MkDocs](https://www.mkdocs.org/) with

0 commit comments

Comments
 (0)