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

Change CitationBibliography to DocumenterBibliography? #16

Closed
ali-ramadhan opened this issue Oct 23, 2020 · 6 comments
Closed

Change CitationBibliography to DocumenterBibliography? #16

ali-ramadhan opened this issue Oct 23, 2020 · 6 comments

Comments

@ali-ramadhan
Copy link
Owner

@charleskawczynski What do you think of changing CitationBibliography to DocumenterBibliography?

CitationBibliography sounds somewhat redundant while DocumenterBibliography might be a bit more descriptive.

@charleskawczynski
Copy link
Collaborator

I'm fine with changing it if you'd like. I found it tricky to come up with a good/intuitive name for this. I was thinking at the time: what should we call the struct indicating where all of the citations in this package are collected? Perhaps it would be a good idea to get input from the Julia community?

@simonbyrne
Copy link
Collaborator

Why not just Bibliography?

@ali-ramadhan
Copy link
Owner Author

Hmmm, Bibliography might conflict with Bibliography.jl.

Well, Bibliography.jl does not define a Bibliography type. It returns an OrderedDict when you call import_bibtex("example.bib") so Bibliography might be fine.

@Azzaare would it be safe if we used Bibliography or do you have plans to add a Bibliography type to Bibliography.jl? Perhaps it makes sense to share a Bibliography type here?

@simonbyrne
Copy link
Collaborator

I don't think it would work, because the Bibliography module would already be using the name (this is why a lot of packages are named with a plural).

@simonbyrne
Copy link
Collaborator

I think CitationBibliography is fine for now.

@simonbyrne
Copy link
Collaborator

In 1.6 you will be able to rename imports (JuliaLang/julia#37396)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants