Commit 1c59bd68 authored by Dmitry Mozzherin's avatar Dmitry Mozzherin
Browse files

Fix #44 docs for canonicalName fields

parent 98f14998
Pipeline #45889978 passed with stages
in 7 minutes and 44 seconds
......@@ -2,6 +2,8 @@
## Unreleased
- Add [#44]: documentation for canonicalName fields
## [v0.7.2]
- Add [#41]: parse/clean multiple names from standard input.
......
......@@ -8,8 +8,10 @@
* If you're unable to find an open issue addressing the problem, [open a new
one](https://gitlab.com/gogna/gnparser/issues/new). Be sure to include a
**title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the
expected behavior that is not occurring.
and a **code sample** or an **executable test case** via
[https:parser.globalnames.org](https://parser.globalnames.org) demonstrating
the expected behavior that is not occurring.
* Make sure you **do not put more than one bug report** in the new issue.
## **Do you intend to add a new feature or change an existing one?**
......
......@@ -93,10 +93,20 @@ more efficient JSON conversion.
Canonical forms of a scientific name are the latinized components without
annotations, authors or dates. They are great for matching names despite
alternative spellings. Use the ``canonical -> simple`` or ``canonical -> full``
fields from parsing results for this use case. ``Full`` version of canonical
form includes infra-specific ranks and hybrid character for named hybrids.
You can use ``--format simple`` flag to simplify output.
alternative spellings. Use the ``canonicalName -> simple`` or ``canonicalName
-> full`` fields from parsing results for this use case. ``Full`` version of
canonical form includes infra-specific ranks and hybrid character for named
hybrids.
The ``canonicalName -> simple`` field is good for matching names from different
sources, because sometimes dataset curators omit hybrid sign in named hybrids,
or remove ranks for infraspecific epithets.
The ``canonicalName -> full`` is good for presentation, as it keeps more
details.
If you only care about canonical form of a name you can use ``--format simple``
flag with command line tool or gRPC service.
### Normalizing name-strings
......@@ -411,4 +421,4 @@ Released under [MIT license]
[Dmitry Mozzherin]: https://gitlab.com/dimus
[Geoff Ower]: https://gitlab.com/gdower
[MIT license]: https://gitlab.com/gogna/gnparser/raw/master/LICENSE
[parser-web]: https://parser.globalnames.org
\ No newline at end of file
[parser-web]: https://parser.globalnames.org
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment