Improve readability and grammar of workspace trust docs and popup#15636
Improve readability and grammar of workspace trust docs and popup#15636David-Else wants to merge 3 commits into
Conversation
|
See #15531. I was called out on these docs already, that PR was my attempt to fix them. I feel like this feature is pretty simple, and doesn't really require so thorough explanation of it. I would prefer something akin to my patch: that is, more concise. To be exact: you've left the explanation in the beginning about why we are doing this. I don't feel like this is necessary. I don't think explaining 'Never' button is of any use to anyone. Line 9 in your PR. I would also rephrase the paragraph on line 22 in your patch, everything else is fine with me. |
|
@xe-nul I am sorry I didn't see your pull request before I started this one or I would have contributed to that instead. I have made the changes you suggested and made it more concise, I think it is good now, what do you think? I copied your Windows paths but can't validate them as I don't have Windows, I thought Windows had |
|
Yeah, looks good to me now. Windows paths canonically use backslashes instead of regular ones, but I think you can use them interchangeably nowadays. Still, you might want to change them, otherwise someone will be annoyed by it. |
Improve readability and grammar of workspace trust docs and popup
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
Improve readability and grammar of workspace trust docs and popup
Improve readability and grammar of workspace trust docs and popup
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
PR helix-editor#15582 refactor(workspace_trust): minor changes fix(workspace_trust): secure permissions on Unix fix(workspace_trust): reject paths with \n PR helix-editor#15590 refactor(helix-loader): split out duplicated code In the workspace trust code, the code to search a path in a file was copy-pasted three times. This splits it out into a helper function. refactor(helix-loader): use BufReader to read trust files When the workspace trust files become large, using a BufReader can increase performance, as it won't block until the whole file is loaded into RAM. refactor(helix-loader): cache workspace trust, unify with PROMPTED_WORKSPACES Since `quick_query_workspace()` and `quick_query_workspace_with_explicit_untrust()` are currently called seven times on startup, it makes sense to cache the result. With this in place, the previous cache for prompted workspaces could be merged into this. Docs (helix-editor#15636) Improve readability and grammar of workspace trust docs and popup Rewrite of helix-editor#15592 Merge of helix-editor#15582 and rewritten helix-editor#15592 Change `PathBuf` to `Path`, as per suggestion from archseer Use workspace trust in git subsystem Replace default gitoxide's model of trust (directory ownership) with our own one. Closes helix-editor#15594 Merge of everything with helix-editor#15644 Expand docs; merge wirh everything else Hardening of workspace-trust-related file modes and permissions Do not query for trust if there are no langugage servers to start Refactor: save state into `Editor`; get rid of statics Add an option to disable trust selector pop-up Add `:workspace-exclude` typable command Update docs Add 'Only once' selector option and `:workspace-trust-once` typable Allow setting trust via globbed paths in config Co-authored-by: Rudxain <76864299+Rudxain@users.noreply.github.com> Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net> Co-authored-by: David <12832280+David-Else@users.noreply.github.com>
Improve readability and grammar of workspace trust docs and popup
|
Replaced by #15857 |
I made improvements to the readability and grammar of the workspace trust docs and popup.
I think in the long run it would benefit from screenshots of the popup dialogue, but I don't think the Helix docs has the capability for that with responsive design requirements.
@xe-nul I hope I have your blessings on this, let me know if I need to make any changes, great job on the workspace trust!