docs: add author field to README citation BibTeX#2389
Open
lonexreb wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
Open
docs: add author field to README citation BibTeX#2389lonexreb wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
lonexreb wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Refs: #1316