-
Notifications
You must be signed in to change notification settings - Fork 782
[Auto] Lint docs #10965
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
[Auto] Lint docs #10965
Changes from 1 commit
c870d53
f23c86f
f7beb11
dda4367
71a6c21
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -289,7 +289,7 @@ The settings below influence the behavior of the Mendix web client. | |
| | <a id="commendixwebuiFeedbackSizeWarningThreshold" href="#commendixwebuiFeedbackSizeWarningThreshold">com.<wbr>mendix.<wbr>webui.<wbr>FeedbackSizeWarningThreshold</a> | A warning is logged when the feedback size exceeds the threshold. Feedback is sent from server to client to instruct (for example, to refresh objects or to open a page). They are serialized as "instructions" in the server response. If there are too many instructions, this can have performance implications, as they all have to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. | 5000 | | ||
| | <a id="commendixwebuiStateSizeWarningThreshold" href="#commendixwebuiStateSizeWarningThreshold">com.<wbr>mendix.<wbr>webui.<wbr>StateSizeWarningThreshold</a> | A warning is logged when the state size exceeds the threshold. The state consists of changes in objects and of objects not committed to the database (yet). If there is too much state, this will have performance implications, as the whole state has to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. | 100 | | ||
| | <a id="commendixwebuiCommittedObjectsThreshold" href="#commendixwebuiCommittedObjectsThreshold">com.<wbr>mendix.<wbr>webui.<wbr>CommittedObjectsThreshold</a> | The threshold controls how much data is sent back to the client after executing a microflow. By default, we send back full objects when they are changed or committed. When this threshold is reached, only object GUIDs are sent back instead so that the client knows about the changes while the amount of data sent over the network is reduced. The client will then retrieve the objects later on, if needed. | 100 | | ||
| | <a id="MaxRetrieveAmount" href="#MaxRetrieveAmount">MaxRetrieveAmount</a> | The maximum number of objects the client is allowed to retrieve by list widgets using database datasource runtime operation.<br/>When requesting more objects than allowed, the runtime will enforce the `MaxRetrieveAmount` by setting a limit on the query and will log the following warning: `A retrieve action requested more objects than allowed by the `MaxRetrieveAmount` runtime setting. Amount requested: (...), MaxRetrieveAmount: (...).`<br />*This setting was introduced in Mendix version 11.8.0 and 11.6.5 MTS* | | | ||
| | <a id="MaxRetrieveAmount" href="#MaxRetrieveAmount">MaxRetrieveAmount</a> | The maximum number of objects the client is allowed to retrieve by list widgets using database datasource runtime operation.<br/>When requesting more objects than allowed, the runtime will enforce the `MaxRetrieveAmount` by setting a limit on the query and will log the following warning: `A retrieve action requested more objects than allowed by the`MaxRetrieveAmount`runtime setting. Amount requested: (...), MaxRetrieveAmount: (...).`<br />*This setting was introduced in Mendix version 11.8.0 and 11.6.5 MTS* | | | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch - not sure what is best here.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about just adding quotation marks?: "A retrieve action requested more objects than allowed by the
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let me know if the quotes work or if we should find a different alternative.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it would be better to disable markdownlint on the whole table, or at least just for this rule if not the whole file. Can't find the documentation immediately, but (for example) or whatever the error is.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just added this instead |
||
|
|
||
| ## Metrics Settings{#metrics-settings} | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -282,7 +282,7 @@ The settings below influence the behavior of the Mendix web client. | |
| | <a id="commendixwebuiFeedbackSizeWarningThreshold" href="#commendixwebuiFeedbackSizeWarningThreshold">com.<wbr>mendix.<wbr>webui.<wbr>FeedbackSizeWarningThreshold</a> | A warning is logged when the feedback size exceeds the threshold. Feedback is sent from server to client to instruct (for example, to refresh objects or to open a page). They are serialized as "instructions" in the server response. If there are too many instructions, this can have performance implications, as they all have to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. | 5000 | | ||
| | <a id="commendixwebuiStateSizeWarningThreshold" href="#commendixwebuiStateSizeWarningThreshold">com.<wbr>mendix.<wbr>webui.<wbr>StateSizeWarningThreshold</a> | A warning is logged when the state size exceeds the threshold. The state consists of changes in objects and of objects not committed to the database (yet). If there is too much state, this will have performance implications, as the whole state has to be serialized to the client. For this reason, a warning is logged when the threshold is exceeded. | 100 | | ||
| | <a id="commendixwebuiCommittedObjectsThreshold" href="#commendixwebuiCommittedObjectsThreshold">com.<wbr>mendix.<wbr>webui.<wbr>CommittedObjectsThreshold</a> | The threshold controls how much data is sent back to the client after executing a microflow. By default, we send back full objects when they are changed or committed. When this threshold is reached, only object GUIDs are sent back instead so that the client knows about the changes while the amount of data sent over the network is reduced. The client will then retrieve the objects later on, if needed. | 100 | | ||
| | <a id="MaxRetrieveAmount" href="#MaxRetrieveAmount">MaxRetrieveAmount</a> | The maximum number of objects the client is allowed to retrieve by list widgets using database datasource runtime operation.<br/>When requesting more objects than allowed, the runtime will enforce the `MaxRetrieveAmount` by setting a limit on the query and will log the following warning: `A retrieve action requested more objects than allowed by the `MaxRetrieveAmount` runtime setting. Amount requested: (...), MaxRetrieveAmount: (...).`<br />*This setting was introduced in Mendix version 10.24.16* | | | ||
| | <a id="MaxRetrieveAmount" href="#MaxRetrieveAmount">MaxRetrieveAmount</a> | The maximum number of objects the client is allowed to retrieve by list widgets using database datasource runtime operation.<br/>When requesting more objects than allowed, the runtime will enforce the `MaxRetrieveAmount` by setting a limit on the query and will log the following warning: `A retrieve action requested more objects than allowed by the`MaxRetrieveAmount`runtime setting. Amount requested: (...), MaxRetrieveAmount: (...).`<br />*This setting was introduced in Mendix version 10.24.16* | | | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here - I think this was mine, sorry. |
||
|
|
||
| ## Metrics Settings{#metrics-settings} | ||
|
|
||
|
|
||
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.
Don't know why it does this. Drives me mad!
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.
Yeah, every month I keep fixing it! Will need to find out why this happens