-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
doc: add added #4925
doc: add added #4925
Conversation
Introduces the YAML metadata concept and the "Added" property to the assert documentation.
e5cedd6
to
50977f7
Compare
I'm guessing this kind of data will eventually be visible on the API docs somehow? |
Introduces the YAML metadata concept and the "Added" property to the timers documentation.
Introduces the YAML metadata concept and "Added" property to the repl documentation.
Are there plans to migrate existing comment-style metadata to YAML? <!--type=property-->
<!--name=[index]--> |
@TimothyGu In the long term, yes — we're working to replace the old doctool with one powered by remark. The proposed Docs WG |
@chrisdickinson, looks very interesting. Thanks for the link! |
temporarily dropping the don't land on v4 label on this. once it's more complete we can look at backporting it all. |
@jasnell, this one will take a week or two. It's quite a bit of manual work.
Checkout first commit, verify it exists, see if it existed but in a different fashion in the diff, if it did, research using that string, etc, etc If anyone knows of a better method, I'm all ears |
Yeah, I don't envy your task :-) |
Introduces the YAML metadata concept and "Added" property to the zlib documentation.
Just an update, I've been really busy these last couple of months. I plan on finishing this, its not going anywhere, but its low on my list right now. As this is quite the manual process I might be inclined to suggest we land the ability to parse and add the added information now (with what I've done so far) and let others have the chance to jump in for the rest. |
7da4fd4
to
c7066fb
Compare
Closing this as this has conflicts + 2 of the files actually have been checked off in #6578, but I mentioned the remaining commits from this PR that may be useful there (both would be blocked by major doc file rewrites right now anyway). |
This is still a work in progress, as this will be a lot of changes, I figure the longer eyes can see it, the better.
This requires #3867
Introduces the YAML metadata concept and the "Added" property to the
documentation.
...adding to the list as I go