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

docs: surface dictionary_path-related settings #101

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yaauie
Copy link
Contributor

@yaauie yaauie commented Jun 4, 2024

Makes refresh_interval and refresh_behaviour more discoverable in the context of dictionary_path

Comment on lines +160 to 163
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>

The full path of the external dictionary file. The format of the table should be
a standard YAML, JSON, or CSV.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the initial request for clarification we also need to make clear that the contents are entirely stored in memory. A suggestion:

Suggested change
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>
The full path of the external dictionary file. The format of the table should be
a standard YAML, JSON, or CSV.
* See also: <<plugins-{type}s-{plugin}-refresh_interval>> and <<plugins-{type}s-{plugin}-refresh_behaviour>>
The full path of the external dictionary file.
The dictionary is read into memory to allow fast lookups, so make sure the JVM Heap is sized to fit its entire content.
The format of the table should be a standard YAML, JSON, or CSV.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants