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 documentation for the startIndex argument of restArguments #3003

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

Conversation

jgonggrijp
Copy link
Collaborator

Motivation: DefinitelyTyped/DefinitelyTyped#71151 (comment)

Preview of the added paragraph: https://cdn.statically.io/gh/jgonggrijp/underscore/document-restarguments-startindex/index.html#restArguments-startIndex

If anyone has suggestions for ways to simplify the explanation, I'm interested.

@jgonggrijp jgonggrijp added documentation starter good choice for new contributors labels Feb 20, 2025
@jgonggrijp
Copy link
Collaborator Author

CC to @codejeffrey @Aurimas-stack @elkcityhazard @deining @colingm because you recently contributed or otherwise expressed interest. If one (or a few) of you would be willing to give this a quick review, I would highly appreciate it.

To review, just click on the "preview" link in the description and tell me whether you find the documentation clear enough. Bonus points if you can think of a way to simplify the explanation.

@jgonggrijp
Copy link
Collaborator Author

@GammaGames @Yahasana would one of you be willing to give this a review? Mentioning you because you expressed willingness to be mentioned over at Backbone.

@colingm
Copy link
Contributor

colingm commented Feb 21, 2025

@jgonggrijp one of the challenges I see with the documentation for this function in general (the original example too, not just your additions), is the lack of showing the output. In various other function docs we see logs to a mock console but in this one we are just shown that the rest get called to "sendConsolations". I think it would go a long way to show with some mock console output a log statement of like "Sorry Sneezy!", "Sorry Bashful!", etc. and then to show that with the start index it is actually "Sorry Happy!" etc.

@jgonggrijp
Copy link
Collaborator Author

@colingm great suggestion, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation starter good choice for new contributors
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants