Closed elliotwaite closed 1 year ago
Wow, thank you so much Elliot! @scottamain can you take a look at these next week?
Yes, thank you for all the suggestions!
No problem, happy to help. I've been enjoying learning about Mojo.
If the docs become available on GitHub in the future, I'll be sure to submit a PR instead, but hopefully this method of submitting docs suggestions works in the meantime.
+1, I'd like that too, we just have to get a bit more organized.
Sounds good. This works for me for now.
Woah, @scottamain, I just realized I worked with you at Google! Back around 2016. We were on different teams but your desk was pretty close to mine. Small world. Modular seems like a cool team to be a part of. Hope you're doing well.
Haha, yeah @elliotwaite! My reflexes recognized you and I didn't pause to realize you didn't have access to these files. 😆 Great to see you exploring Mojo! I've been at Modular for a month (it's awesome!) so still exploring it myself.
Haha, nice. Yeah, for a second there I thought there was another public repo I was unaware of, but that makes sense now.
I'm glad to hear you're enjoying it. It seems like an exciting time to be there. From what I've been seeing online, it seems like a lot of people are rooting for you guys.
Well, I should probably save the chitchat for somewhere other than this GitHub issue, but it's good to hear from you, and I'll be looking forward to reading your writing.
Thanks again @elliotwaite ! I believe all doc these issues have been resolved. Many are online now and others will be published soon.
As for the website toggle bug, this is a website framework issue and I can't repro on my mobile, so pretty low priority for us. But thanks for the heads up; I'll look out for similar issues.
Sounds good.
Here are some potential docs fixes I found. I'm not sure if they're all correct so feel free to ignore any that are unwanted.
Page: Why Mojo🔥
"intentions" → "intention"
"gives good" → "gives us good"
"benefit" → "benefits"
"allows use" → "allows the use"
"field ML" → "ML field"
"supports development" → "supports the development"
"embraced" → "to embrace"
"and built" → "and is built"
"building" → "build"
"challenges" → "challenge"
Page: Mojo🔥 programming manual
Location: Overloaded functions and methods
"use" → "uses" "as ambiguous" → "is ambiguous"
Location: Using parameterized types and functions
Maybe these variables should use snake case to align with the standard Python style (
small_vec
,big_vec
,bigger_vec
,bigger_vec_2
).Location: The
__copyinit__
and__moveinit__
special methodsI think "offer" should be inserted after "Rust".
Location: Parameterization: compile time meta-programming
Insert an "and" after the comma, like this:
Location: Autotuning / Adaptive compilation
I think this is supposed to be
best_idx = i
.Location: Why argument conventions are important
The double quotes could be fixed here, but it might look even better if they were removed altogether, like this:
There are several other occurrences of double quotes around inline code elements on this page where I think the double quotes could be removed since they seem somewhat redundant, but that may just be my personal taste:
Location:
fn
definitionsobject
”Location: Defining parameterized types and functions
SIMD[type, size]
”Location: “Borrowed” argument convention
print_id
”const&
”const&
”use_something_big
”Int
”, “Float
”, and “SIMD
”@register_passable
”Location: “Owned” argument convention and postfix
^
operator"my" → "may"
Location:
@register_passable
struct decoratorThis reads strangely because the "a" is singular but "methods" is plural. I think the "a" can be removed:
Also in this section:
Maybe "have predictable" should be "have a predictable".
A space can be added between
@register_passable
and "arguments". And maybe "result" should be changed to "results" or "the result" to make it read more smoothly.I think "and returns its result by-value" should be "and they return their results by-value".
Location: “Value Lifecycle”: Birth, life and death of a value
I think "together together" is supposed to be "them together".
Location: Non-movable and non-copyable types
I think "and cannot" is supposed to be "they cannot".
Location: Unique “move-only” types
I think
consuming existing: Self
is supposed to beowned existing: Self
. This occurs a second time on this page in the Types that support a “stealing move” section:fn __moveinit__(self&, consuming existing: Self): # as above
Also in this section, I think the code comment
# This is the new.
was supposed to be something like# This is the new key capability.
(which is what the comment is in the example slightly below it.Also in this section:
"it another" → "it to another"
Location: Copyable types
"types, that we" → "types, we"
"owns their" → "owns its"
"to use frequently transform" → "to frequently transform"
Location:
@value
decorator"suppress generation" → "suppress the generation"
Location: Behavior of destructors
Maybe "end of scope" should be "end of the scope".
Location:
@parameter
decorator"captures" → "capture"
Location: Field lifetimes of
owned
arguments in__del__
and__moveinit__
In the section title, a space can be added between
__del__
and "and".Also in this section, there are two places where
consume(^str1)
is used, but I thought the^
was supposed to be a postfix operator unless I'm confused and this is different than the postfix-^
"consume" operator.Also in this section:
Remove the extra line breaks between "somehow," and "this".
Location: Direct access to MLIR
I'm not sure, but I think the ending of this sentence was supposed to be "
__mlir_type
,__mlir_op
, and__mlir_attr
constructs".Maybe "and standard library" should be "and the standard library".
Page: Mandelbrot in Mojo with Python plots
"huge" → "the huge"
Page: Mojo🔥 roadmap & sharp edges
"acknowledgement" → "acknowledgment"
"later" → "latter"
"parameter" → "a parameter"
"rememdy" → "remedy"
"indirectin" → "indirection"
take_int_pair
→take_int_triple
IntPair
→IntTriple
"accesses" → "access"
"avaiable" → "available"
Other
Locaion:
simd_strided_load
"store" → "load"
"stores" → "loads"
Location:
PrefetchOptions
I'm not sure if this is anything that needs to be fixed, but it seemed odd to me so I thought I'd mention it here just in case. The docs mention the possible
VeryHighLocality
value, but the highestPrefetchLocality
alias isHIGH
and the highest locality-related method ishigh_locality()
, neither having a "very high" variant. So I wasn't sure if this inconsistency was intentional or not.Also, when viewing the docs on an iPad using Chrome, toggling the light/dark-theme switch resets the scroll position to the top of the page.