Add check keyword to docstring

Humans-of-Julia · Nov 2, 2024 · 48cad7b · 48cad7b
1 parent 8f9dcc9
commit 48cad7b
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/BibParser.jl b/src/BibParser.jl
@@ -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`.
 """
@@ -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`.