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.

Sign up for GitHub

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

Add check keyword to docstring #33

Merged
merged 1 commit into from
Nov 2, 2024
Merged

Add check keyword to docstring #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/BibParser.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include("cff.jl")
using .CFF: CFF

"""
parse_file(path::String; parser::Symbol = :BibTeX)
parse_file(path::String, parser::Symbol = :BibTeX; check=:error)
Parse a bibliography file. Default to BibTeX format. Other options available: CFF (CSL-JSON coming soon).
For bibliography formats with formatting rules (such as `:BibTeX`), the `check` keyword argument can be set to `:none` (or `nothing`), `:warn`, or `:error`.
"""
Expand All @@ -28,7 +28,7 @@ parse_file(path, ::Val{:CFF}; check) = CFF.parse_file(path)
parse_file(path, parser=:BibTeX; check=:error) = parse_file(path, Val(parser); check)

"""
parse_entry(entry::String; parser::Symbol = :BibTeX)
parse_entry(entry::String; parser::Symbol = :BibTeX, check = :error)
Parse a string entry. Default to BibTeX format. No other options available yet (CSL-JSON coming soon).

For bibliography formats with formatting rules (such as `:BibTeX`), the `check` keyword argument can be set to `:none` (or `nothing`), `:warn`, or `:error`.
Expand Down