Skip to content

docs: add author field to README citation BibTeX#2389

Open
lonexreb wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
lonexreb:docs/1316-citation-author
Open

docs: add author field to README citation BibTeX#2389
lonexreb wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
lonexreb:docs/1316-citation-author

Conversation

@lonexreb
Copy link
Copy Markdown

@lonexreb lonexreb commented May 4, 2026

Summary

Closes #1316.

The `@misc{nemo-rl,...}` BibTeX entry in README's Citation section is
missing an `author` field. Most BibTeX styles refuse to format a
`@misc` entry without an author, which makes the suggested snippet
impractical to paste straight into a LaTeX paper — researchers have to
edit it by hand before it renders, defeating the point of providing a
canonical citation.

Change

 @misc{nemo-rl,
+author = {{NVIDIA}},
 title = {NeMo RL: A Scalable and Efficient Post-Training Library},
 howpublished = {\url{https://github.com/NVIDIA-NeMo/RL}},
 year = {2025},
 note = {GitHub repository},
 }

The double braces around `NVIDIA` are intentional — they preserve the
all-caps casing and stop BibTeX styles from parsing the token as a
"Last, First" personal-name. This is the conventional way to cite a
corporate / institutional author in BibTeX.

Verification

```tex
\documentclass{article}
\bibliographystyle{plain}
\begin{document}
\nocite{nemo-rl}
\bibliography{refs} % paste the README block into refs.bib
\end{document}
```

Before this PR: BibTeX errors with `I'm skipping whatever remains of this entry`
because the @misc entry has no author and a non-trivial style is being used.
After this PR: renders as `NVIDIA. NeMo RL: A Scalable and Efficient
Post-Training Library, 2025. GitHub repository.`

Test plan

  • Diff is one line.
  • Manually verified the BibTeX renders cleanly with the `plain` style.
  • CI L0 (docs link checks etc).

Refs: #1316

The @misc{nemo-rl,...} BibTeX entry in the Citation section is missing
an ``author`` field. Most BibTeX styles refuse to format a @misc entry
without an author, which makes the suggested snippet impractical to
drop into a real LaTeX paper — users have to edit it by hand.

Add ``author = {{NVIDIA}}`` so the entry is usable as-is. The double
braces preserve the all-caps casing and prevent BibTeX styles from
parsing ``NVIDIA`` as a "Last, First" personal-name.

Refs: NVIDIA-NeMo#1316
Signed-off-by: lonexreb <reach2shubhankar@gmail.com>
@lonexreb lonexreb requested a review from a team as a code owner May 4, 2026 07:07
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 4, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The citation in README should contain an author field

2 participants