Skip to content

doc: add added - #4925

Closed
tflanagan wants to merge 4 commits into
nodejs:masterfrom
tflanagan:doc-add-added
Closed

doc: add added#4925
tflanagan wants to merge 4 commits into
nodejs:masterfrom
tflanagan:doc-add-added

Conversation

@tflanagan

Copy link
Copy Markdown
Contributor

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.


  • assert.markdown
v0.1.21 530328f12b4a00dfbc8ea57bafb1f9344912f0db
ok, fail, equal, notEqual, deepEqual, notDeepEqual, strictEqual, notStrictEqual, throws
v0.1.21 4f679fd8d01c11c908bd5ca439a7aff956cda4ad
doesNotThrow
v0.1.97 fe3d8f2411209b202b7fe74cb48b582ffc5cfc5f
ifError
v0.5.9 8c8d51872361c0a30e56d2497daaf03a04c82849
assert = assert.ok
v1.2.0 3f473ef141fdc7059928ebc4542b00e2f126ab07
deepStrictEqual, notDeepStrictEqual
  • modules.markdown
  • repl.markdown
v0.1.92 b7441040f87ff5e0e7b4575852996b6a64e0ea8f
displayPrompt
start
v0.3.0 56df0cbf93f78daf905eae7bd66daf0910650a72
defineCommand
v0.7.0 3421f433519411c290c732c64dadbb6547e42235
data
v0.9.1 659d449460d84c40fc5b3bf0e23575378d72d312
exit
v0.11.8 eacdd4bf94edc8328f42e3591ba4dd79d347571
reset
  • timers.markdown
v0.0.1 f213a276572a02fa9997c6e0375dc6de1a7333ba
setTimeout, setInterval, clearTimeout, clearInterval
v0.9.1 cd6122edebe09a66a3a1a3fd0904ffda39d9007b
ref, unref
v0.9.1 382f22f22959e686b10a5f42333c468e6654cb97
setImmediate, clearImmediate
  • zlib.markdown
v0.5.8 5b8e1dabbc117b38c56f874f4e6d5b7e537cd3c1
Deflate, Inflate, Gzip, Gunzip, DeflateRaw, InflateRaw, Unzip
createDeflate, createInflate, createDeflateRaw, createInflateRaw, createGzip, createGunzip, createUnzip
flush, end, write, pause, resume

...adding to the list as I go

@thefourtheyethefourtheye added the doc Issues and PRs related to the documentations. label Jan 28, 2016
Introduces the YAML metadata concept and the "Added" property to the
assert documentation.
@tflanagantflanagan changed the title doc: add added for assert.markdowndoc: add addedJan 28, 2016
@mscdex

Copy link
Copy Markdown
Contributor

I'm guessing this kind of data will eventually be visible on the API docs somehow?

@tflanagan

Copy link
Copy Markdown
ContributorAuthor

@mscdex, yes, re: #3867

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.
@TimothyGu

Copy link
Copy Markdown
Member

Are there plans to migrate existing comment-style metadata to YAML?

<!--type=property--><!--name=[index]-->

@chrisdickinson

Copy link
Copy Markdown
Contributor

@TimothyGu In the long term, yes — we're working to replace the old doctool with one powered by remark. The proposed Docs WG ROADMAP is available here.

@TimothyGu

Copy link
Copy Markdown
Member

@chrisdickinson, looks very interesting. Thanks for the link!

@jasnell

Copy link
Copy Markdown
Member

temporarily dropping the don't land on v4 label on this. once it's more complete we can look at backporting it all.

@tflanagan

Copy link
Copy Markdown
ContributorAuthor

@jasnell, this one will take a week or two. It's quite a bit of manual work.

git log --all --reverse -S "<string>" --source

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

@jasnell

Copy link
Copy Markdown
Member

Yeah, I don't envy your task :-)

Introduces the YAML metadata concept and "Added" property to the zlib
documentation.
@tflanagan

Copy link
Copy Markdown
ContributorAuthor

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.

@estliberitas
estliberitasforce-pushed the master branch 2 times, most recently from 7da4fd4 to c7066fbCompareApril 26, 2016 05:22
@addaleax

Copy link
Copy Markdown
Member

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).

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@tflanagan@mscdex@TimothyGu@chrisdickinson@jasnell@addaleax@thefourtheye