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: document rest in array/object destructuring in each blocks #2677

Merged
merged 2 commits into from
Jun 22, 2019

Conversation

mindrones
Copy link
Member

@mindrones mindrones commented May 4, 2019

Closes #2676

Also completed the substitution of the code blocks language from html to sv where applicable.

@mindrones mindrones force-pushed the rest-in-each-2676 branch 2 times, most recently from a361dd3 to 712e807 Compare May 4, 2019 20:04
@mindrones mindrones force-pushed the rest-in-each-2676 branch from 712e807 to b34f04d Compare May 4, 2019 20:14
@Conduitry
Copy link
Member

I'm really wary about having 'since version such-and-such' notices in the API docs. This will become unreadable very soon unless it's done very unobtrusively. (FWIW, there also also some other new 3.1.0 and 3.2.0 features that don't currently/yet have such notes about this.)

Even if this is done unobtrusively, I'm still concerned about it resulting in sort of an append-only-docs situation. We don't want stuff to end up in its own paragraph solely because it was added in a later version. If it makes more sense to slip it in between (or partially replace) some existing documentation, we want to be free to do that, without being being hampered by finding an unambiguous place to put the 'since x.x.x' or an icon or whatever.

@MikeMatrix
Copy link
Contributor

I think generally I'd leave it out.

Although there could be a consideration made to add notes or mentions of when it was added over the last minor version, to ease finding what changed in terms of features available.
Kind of a "THIS IS NEW" flag.
Not sure if that would be the right way, since this would definitely mean having to maintain the documentation a lot more and having to remove tags that would fall away in this process.
Sounds pretty tedious.

Generally I'd still refer to that through a well maintained CHANGELOG.md

@mindrones mindrones force-pushed the rest-in-each-2676 branch 3 times, most recently from c8ead68 to 63e4049 Compare May 4, 2019 22:38
@mindrones mindrones added docs and removed docs labels May 20, 2019
@mindrones mindrones force-pushed the rest-in-each-2676 branch from 63e4049 to 369b087 Compare June 22, 2019 16:26
@mindrones
Copy link
Member Author

I've removed all the substitutions html -> sv (I had removed the versioning stuff back in May), OK to merge?

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

Successfully merging this pull request may close these issues.

Doc: document rest in array/object destructuring in each blocks
3 participants