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

CLI documentation discrepancy for style default #238

Open
aaron-jack-manning opened this issue Oct 15, 2024 · 1 comment
Open

CLI documentation discrepancy for style default #238

aaron-jack-manning opened this issue Oct 15, 2024 · 1 comment

Comments

@aaron-jack-manning
Copy link

The README provides an example:

hayagriva literature.yml reference

which seems to fail because the --style argument is not provided.

The next line indicates that there is supposed to be a default

Hayagriva defaults to the Author-Date style of the Chicago Manual of Style (17th edition). If you prefer to use another style, you can, for example, do the following to use the style of the American Psychological Association instead:

hayagriva literature.yml reference --style apa

I'm happy to fix this although it's not clear to me if the behavior of the CLI or the documentation is the correct source of truth here.

@gl-yziquel
Copy link

I remarked the same thing about the documentation discrepancy.

@aaron-jack-manning I believe it's always good to keep doc in sync. I'd advise fixing the documentation as it's the low hanging fruit. If PR is rejected, than it means the code is to be fixed. That would be my take, in the absence of a reply.

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

2 participants