Update app.rst #2297
Update app.rst #2297
Conversation
The explanation for 'all' option sidebar mode was not clear probably due to a typo.
| @@ -302,8 +302,7 @@ samples or fields, this may involve substantial computation. | |||
|
|
|||
| Therefore, the App supports three sidebar modes that you can choose between: | |||
|
|
|||
| - `all`: always compute counts for all fields and stats for all fields whose | |||
| filter tray is expanded | |||
| - `all`: always compute counts for all fields and stats | |||
There was a problem hiding this comment.
What the previous version of the docs were trying to convey is that, in all mode:
- The count values will be shown for all fields that are visible in the sidebar
- In addition, the data inside the "filter tray" (eg the
idandlabelwidgets you see after clicking the down caret in the image below) will be computed whenever the sidebar loads
Do you have any suggestion for how to edit the docs in a different way to make that more clear? In your proposed version I think it may not be clear what "stats" means without some additional context
There was a problem hiding this comment.
OK. Thanks for the detailed clarification.
After your explanation, I agree that my proposed version needs updating.
As an outsider reading the document(before your explanation), I did not know what "stats" is. Referring to it as 'stats' may be confusing when there is also a 'Statistics tabs' in the App.
My confusion led me think that there is a typo considering the redundant for all fields in 'all' bullet.
So, my new suggestion is:
all: always compute counts (for all fields -> this part can be removed) and stats (-> this can be renamed) for all fields whose filter tray is expanded
What changes are proposed in this pull request?
The explanation for 'all' option sidebar mode was not clear probably due to a typo.