From 4c92ef03acc5dc983a4ed6c587257e396ef507c0 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Fri, 22 Jan 2021 15:26:19 +0300 Subject: Style: use the right string --- docs/dev/style.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'docs/dev/style.md') diff --git a/docs/dev/style.md b/docs/dev/style.md index 389649398..7e6cd49e0 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md @@ -6,6 +6,9 @@ Our approach to "clean code" is two-fold: It is explicitly OK for a reviewer to flag only some nits in the PR, and then send a follow-up cleanup PR for things which are easier to explain by example, cc-ing the original author. Sending small cleanup PRs (like renaming a single local variable) is encouraged. +When reviewing pull requests prefer extending this document to leaving +non-reusable comments on the pull request itself. + # General ## Scale of Changes @@ -375,6 +378,15 @@ This allows for exceptionally good performance, but leads to increased compile t Runtime performance obeys 80%/20% rule -- only a small fraction of code is hot. Compile time **does not** obey this rule -- all code has to be compiled. +## Appropriate String Types + +When interfacing with OS APIs, use `OsString`, even if the original source of +data is utf-8 encoded. **Rationale:** cleanly delineates the boundary when the +data goes into the OS-land. + +Use `AbsPathBuf` and `AbsPath` over `std::Path`. **Rationale:** rust-analyzer is +a long-lived process which handles several projects at the same time. It is +important not to leak cwd by accident. # Premature Pessimization -- cgit v1.2.3