Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Introduce function parameters in the function page. #3787

Open
RichardCoppin opened this issue Nov 20, 2024 · 0 comments
Open

[Docs] Introduce function parameters in the function page. #3787

RichardCoppin opened this issue Nov 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation mojo-repo Tag all issues with this label

Comments

@RichardCoppin
Copy link

Where is the problem?

https://docs.modular.com/mojo/manual/functions

What can we do better?

My proposal is to introduce function parameters up front in the initial introduction of the function fn syntax.

Not doing so, places the reading with a mental "broken link". Anyone coming across the function parameter syntax in a code base or API reference for the first time will not be able to ascertain what this arcane syntax actually means.

Secondly, the footnote refers to the term parameters without any explanation of what that term means.
image

Once the function parameters have been introduced then place the hyperlink for the remainder of the discussion of parameters versus arguments.

TL;DR:

Function parameters need to be introduced here:
image

Anything else?

No response

@RichardCoppin RichardCoppin added documentation Improvements or additions to documentation mojo-repo Tag all issues with this label labels Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation mojo-repo Tag all issues with this label
Projects
None yet
Development

No branches or pull requests

1 participant