Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update tenses of doc comment summary lines (#4161)

Browse source 
This PR updates the tenses used by the summary line of doc comments to
match the [Rust API documentation
conventions](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#summary-sentence).

Specifically:

> The summary line should be written in third person singular present
indicative form. Basically, this means write ‘Returns’ instead of
‘Return’.

I'm sure there are plenty occurrences that I missed.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-01-19 11:18:50 -05:00 • committed by GitHub
parent cb1b7915ee
commit 01f06f96a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 75 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/settings/src/settings_store.rs
View file

@ -246,7 +246,7 @@ impl SettingsStore {
this
}
/// Update the value of a setting in the user's global configuration.
/// Updates the value of a setting in the user's global configuration.
///
/// This is only for tests. Normally, settings are only loaded from
/// JSON files.
@ -261,7 +261,7 @@ impl SettingsStore {
self.set_user_settings(&new_text, cx).unwrap();
}
/// Update the value of a setting in a JSON file, returning the new text
/// Updates the value of a setting in a JSON file, returning the new text
/// for that JSON file.
pub fn new_text_for_update<T: Settings>(
&self,
@ -276,7 +276,7 @@ impl SettingsStore {
new_text
}
/// Update the value of a setting in a JSON file, returning a list
/// Updates the value of a setting in a JSON file, returning a list
/// of edits to apply to the JSON file.
pub fn edits_for_update<T: Settings>(
&self,
@ -344,7 +344,7 @@ impl SettingsStore {
DEFAULT_JSON_TAB_SIZE
}
/// Set the default settings via a JSON string.
/// Sets the default settings via a JSON string.
///
/// The string should contain a JSON object with a default value for every setting.
pub fn set_default_settings(
@ -362,7 +362,7 @@ impl SettingsStore {
}
}
/// Set the user settings via a JSON string.
/// Sets the user settings via a JSON string.
pub fn set_user_settings(
&mut self,
user_settings_content: &str,