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

Update main entry-point docs to use lowercase args #54252

Closed
mbauman opened this issue Apr 25, 2024 · 2 comments · Fixed by #54288
Closed

Update main entry-point docs to use lowercase args #54252

mbauman opened this issue Apr 25, 2024 · 2 comments · Fixed by #54288
Labels
docs This change adds or pertains to documentation

Comments

@mbauman
Copy link
Sponsor Member

mbauman commented Apr 25, 2024

I would like to suggest a change to the doc to recommend users define main as main(args) instead of main(ARGS) to clarify the differences between the global var Core.ARGS and the function parameter. Defining the main(ARGS) is confusing to me if the ARGS is just a normal parameter.

Originally posted by @ctarn in #50974 (comment)

@mbauman mbauman added the docs This change adds or pertains to documentation label Apr 25, 2024
@ctarn
Copy link
Contributor

ctarn commented Apr 25, 2024

It would be great if we could finish it before the release of 1.11.0. I am also happy to prepare a PR if needed. I can start it tomorrow since I'm struggling with a report due in 12 hours later...

@mbauman
Copy link
Sponsor Member Author

mbauman commented Apr 25, 2024

That'd be great — go for it! I just didn't want your comment to get lost.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants