-
Notifications
You must be signed in to change notification settings - Fork 6
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
Clarify terms, query intervals and impacts #469
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggested some alternative wordings, please feel free to merge them with your own.
| Specifies the default interval of checking for new server notifications in milliseconds. | ||
| `300000` + | ||
(30s) | ||
| The interval in milliseconds in which the Desktop app checks the server for new notifications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
300000ms = 5 Minutes
fixed
To round things up, the behavior changes in 5.0 🥳 |
I propose we merge this and you file an issue describing the changes for 5.0 which I then only apply to master. |
All: I have updated the content, could you pls check and approve? |
Polling is defined as the task where the Desktop app queries the server for changes. If the server responds with a change that had happened on the backend, the client will start syncing the changes after polling has finished. | ||
|
||
* *Sync* + | ||
Syncing is defined as the task where any changes will be synchronized, no matter if they occurred in the Desktop app or on the server side. Syncing does not depend on former polling while polling can result in a sync. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Syncing" is not used as a term anywhere in the code or docs, while "sync" is. We should avoid using the present participle and treat "sync" as a specific noun.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linguistically there's nothing wrong with syncing as the gerund (noun) or continuous form of verbs. In the documentation we use it a lot. No reason to ban certain forms of word.
https://www.merriam-webster.com/dictionary/syncing
Co-authored-by: Phil Davis <phil@jankaritech.com>
Co-authored-by: Fabian Müller <80399010+fmoc@users.noreply.github.com>
Co-authored-by: Fabian Müller <80399010+fmoc@users.noreply.github.com>
Co-authored-by: Michael Stingl <214010+michaelstingl@users.noreply.github.com>
Co-authored-by: Edith Parzefall <edith_parzefall@gmx.de>
ca3690e
to
41a5ebd
Compare
Fixes: #266 (Document the desktop clients query intervals and the impacts)
Fixes: #91 (Poll interval from capabilities)
The terms used were not clear and the text needed improvement for better understanding.
The split of the content and the explanation was based on a discussion with @fmoc (many thanks for the input)
Language review welcomed 😄
Backport to 4.0 and 4.1