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

Document "default mode" queries #158

Open
goodmami opened this issue Jan 3, 2022 · 0 comments
Open

Document "default mode" queries #158

goodmami opened this issue Jan 3, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@goodmami
Copy link
Owner

goodmami commented Jan 3, 2022

In #157 I noticed that the "default mode" for queries is not documented, even though it is mentioned in the CHANGELOG and in some issues like #90 and #92. It should be explained at least once in the documentation and referred to from some relevant places (Wordnet class API docs, Basic Usage and Interlingual Queries guides, maybe others). I have, however, been trying to emphasize the module functions less in favor of creating Wordnet objects, so the description would be better with some admonishment to use Wordnet objects in most cases (e.g., with a warning that path methods in default-mode can be very slow when many lexicons are installed).

Note that default mode is enabled when either (a) a module function like wn.synsets() is used without any lexicon or lang parameter, or (b) a Wordnet object is created without any lexicon or lang parameter.

@goodmami goodmami added the documentation Improvements or additions to documentation label Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant