Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG: plugin API citations auto-format citation title capitalization #341

Open
nbokulich opened this issue Aug 8, 2018 · 1 comment
Open
Labels
bug-sev:1|negligible bug-type:1|cosmetic UX is less than ideal; something is superficially wrong. lang:jinja2 A templating language. lang:misc Anything that doesn't fit, such as a conda recipe. lang:python Python 3 scope:0|this-project No other repositories are impacted. src:self From the original poster. type:bug Something is wrong.

Comments

@nbokulich
Copy link
Member

Bug Description
Plugin citation titles become capitalized (and subsequent letters lowercase) in the plugin API documentation, even if the titles should not be capitalized (or all caps). This is not consistent with the bibtex citations in the source code. Problematic for software article titles, e.g., see examples below.

Steps to reproduce the behavior
See examples:
q2-dada2
observed: Dada2: high-resolution sample inference from Illumina amplicon data
expected: DADA2: high-resolution sample inference from Illumina amplicon data
q2-sample-classifier
observed: Q2-sample-classifier: machine-learning tools for microbiome classification and regression
expected: q2-sample-classifier: machine-learning tools for microbiome classification and regression
q2-longitudinal
observed: Q2-longitudinal: a qiime 2 plugin for longitudinal and paired-sample analyses of microbiome data
expected: q2-longitudinal: a qiime 2 plugin for longitudinal and paired-sample analyses of microbiome data

Expected behavior
Titles should not auto-capitalize

@thermokarst thermokarst added type:bug Something is wrong. bug-sev:1|negligible bug-type:1|cosmetic UX is less than ideal; something is superficially wrong. lang:jinja2 A templating language. lang:misc Anything that doesn't fit, such as a conda recipe. lang:python Python 3 scope:0|this-project No other repositories are impacted. src:self From the original poster. labels Aug 8, 2018
@thermokarst
Copy link
Contributor

These problems can all be fixed in the plugin citations. For example, with DADA2:

title={DADA2: high-resolution sample inference from Illumina amplicon data},

to...

title={{DADA2}: high-resolution sample inference from Illumina amplicon data},

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-sev:1|negligible bug-type:1|cosmetic UX is less than ideal; something is superficially wrong. lang:jinja2 A templating language. lang:misc Anything that doesn't fit, such as a conda recipe. lang:python Python 3 scope:0|this-project No other repositories are impacted. src:self From the original poster. type:bug Something is wrong.
Projects
None yet
Development

No branches or pull requests

2 participants