docs: fix typos #724
docs: fix typos #724
Conversation
There was a problem hiding this comment.
Thanks a lot, it's a pretty decent result and a lot of mistakes removed. Much appreciated.
I noticed that it doesn't shy away from fixing spelling mistakes in enumeration variants, which technically is a breaking change. All of these changes where in errors so I think it's OK as people are unlikely to actually match on these cases.
On another note, it was happy to change unencoded to encoded, inverting the meaning in the process. I will change that back.
| @@ -64,7 +64,7 @@ fn get_value_for_all_provided_values() -> crate::Result { | |||
| &[cow_str("")], | |||
| ); | |||
|
|
|||
| assert_eq!(config.string("doesnt", None, "exist"), None); | |||
| assert_eq!(config.string("doesn't", None, "exist"), None); | |||
There was a problem hiding this comment.
This is interesting as I didn't dare putting ' into section names for query. But it's OK to do that and has the same effect, good to see.
| @@ -45,7 +45,7 @@ pub trait Find { | |||
| /// Returns true if the object exists in the database. | |||
| fn contains(&self, id: impl AsRef<git_hash::oid>) -> bool; | |||
|
|
|||
| /// Find an object matching `id` in the database while placing its raw, undecoded data into `buffer`. | |||
| /// Find an object matching `id` in the database while placing its raw, encoded data into `buffer`. | |||
There was a problem hiding this comment.
This isn't correct - it should remain unencoded or something semantically similar, not opposite.
There was a problem hiding this comment.
Hi, sorry about that, I think the confusion came from that it's originally "undecoded", not "unencoded". Either way, since both undecoded and unencoded aren't actually words, I think it would be better to use their positive counterpoint, encoded and decided respectively.
|
My pleasure! |
|
@Byron, did you see my response to your comment? |
Thank you @Lioness100 for the persistence :).
|
My apologies - I didn't realise my mistake until now. Thank you for the persistence (it's fixed now)! |
|
No problem, glad I could help! |
Fixed one or two typos 😉 (this was a trial run for a CLI I made)
Ok for Byron review the PR on video?
If I think the review will be helpful for the community, then I might record and publish a video.