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

Add argument labels when invoking "apply the history step" #10033

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

awesomekling
Copy link
Member

@awesomekling awesomekling commented Jan 2, 2024

It was very hard to parse these invocations (i.e "... null, null, null, and null"), since you'd have to remember what all those nullable parameters are.

By adding argument labels with the format "value as parameter", we make it much clearer what's being passed as what.


IMO this kind of clarification could be helpful in many more places, but I'm just testing the waters with this small PR after being encouraged by @noamr on X :)


/browsing-the-web.html ( diff )

It was very hard to parse these invocations, since you'd have to
remember what all those nullable parameters are.

By adding argument labels with the format "value as parameter",
we make it much clearer what's being passed as what.
Copy link
Contributor

@noamr noamr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working at this, please follow the example here: Note how you have a dfn for each of the named parameters and the <i> references need to have a data-x attribute that matches that dfn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants