From 223374969205059f3448ef9e9d7ab1c44d5fa8cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Thu, 1 Oct 2020 21:02:39 +0300 Subject: Improve grammar and fix code example in style guide --- docs/dev/style.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'docs/dev/style.md') diff --git a/docs/dev/style.md b/docs/dev/style.md index bcd86fd3f..f0fdb5adc 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md @@ -197,7 +197,7 @@ fn frobnicate(walrus: Option) { } ``` -Avoid preconditions that spawn function boundaries: +Avoid preconditions that span across function boundaries: ```rust @@ -218,9 +218,8 @@ fn foo() { } // Not as good -fn is_string_literal(s: &str) -> Option<&str> { +fn is_string_literal(s: &str) -> bool { s.starts_with('"') && s.ends_with('"') - Some() } fn foo() { @@ -231,8 +230,8 @@ fn foo() { } ``` -In the "Not as good" version, the precondition that `1` is a valid char boundary is checked in `is_string_literal` and utilized in `foo`. -In the "Good" version, precondition check and usage are checked in the same block, and then encoded in the types. +In the "Not as good" version, the precondition that `1` is a valid char boundary is checked in `is_string_literal` and used in `foo`. +In the "Good" version, the precondition check and usage are checked in the same block, and then encoded in the types. # Early Returns -- cgit v1.2.3