Proofread some code/docs #1108
Proofread some code/docs #1108
Conversation
There was a problem hiding this comment.
Wow, you caught a lot of mistakes! Nice. Some of these I'm not so sure about, particularly the ones with hyphens, and I'm unlikely to remain consistent with all of them in the future. But I'm not too worried about it.
- Yes, "escapeable" should just be "escapable." I just apparently don't know how to spell that word. (I suppose one could say I don't know how to spell a lot of words, haha, but I think a lot of these are typos.)
- "determinizing" seems fine to me? Not sure what the alternative is.
- "Padron" is a type of cigar. It's intentional. :-)
Otherwise just a few small nits and this should be good to go.
| @@ -772,7 +772,7 @@ fn write_varu32(data: &mut Vec<u8>, mut n: u32) { | |||
| /// | |||
| /// https://developers.google.com/protocol-buffers/docs/encoding#varints | |||
| fn read_varu32(data: &[u8]) -> (u32, usize) { | |||
| // N.B. We can assume correctness here since we know that all varuints are | |||
There was a problem hiding this comment.
I think "varuints" is what I actually meant here.
There was a problem hiding this comment.
I suspect most people will automatically read "variants", defeating the purpose :) Can you think of another word for this, e.g. "var-u32"?
regex-automata/src/util/wire.rs
Outdated
| @@ -370,7 +370,7 @@ pub(crate) fn alloc_aligned_buffer<T>(size: usize) -> (Vec<u8>, usize) { | |||
| // NOTE: This is a kludge because there's no easy way to allocate a Vec<u8> | |||
| // with an alignment guaranteed to be greater than 1. We could create a | |||
| // Vec<u32>, but this cannot be safely transmuted to a Vec<u8> without | |||
| // concern, since reallocing or dropping the Vec<u8> is UB (different | |||
There was a problem hiding this comment.
I think I meant "reallocing" here, as in "to call realloc." I suppose "reallocating" is close enough, but I think I like "reallocing" better? I don't feel strongly.
|
Ok, i fixed them all, with the exception of |
* `escapeable` should be replaced by `escapable`, but it is part of a pub fn
|
@BurntSushi hi, any blockers for this? |
Possible TODOs (not blocking):
escapeableshould be replaced byescapable-- too many occurrences to replacedeterminizingis another weird one"Padron"-- is that intentional?