Ryan Graham
5ac6f4de13
doc: improve module documentation
...
Expands on when to use module.exports vs. exports. This is a recurring
question on mailing list and continues to confuse new devs.
2013-10-27 11:47:11 +01:00
Sam Roberts
5fc8efb87d
doc: call console module 'console' not 'stdio'
...
The console module has always been called 'stdio' in the
table-of-contents, but nowhere else, since its name is
'console'. This makes it difficult to find.
This is a back-port of commit 226a20d
2013-06-18 22:50:19 +02:00
Ryan Graham
93391ae9cb
doc: clarify exports and module.exports
...
When exporting a single function you must use `module.exports` instead
of the `exports` convenience reference.
2013-05-15 21:05:57 +02:00
isaacs
dda7b40204
doc: Fix require.extensions documentation
...
1. The stability index must come first, or it messes up the markdown
2. require.extensions is an Object, not an Array.
Close #5387
2013-04-30 07:40:43 -07:00
isaacs
7bd8a5a2a6
doc: Deprecate require.extensions
2013-04-28 22:10:40 -07:00
Ben Noordhuis
c79fd0e167
doc: remove broken require.extensions example
...
Fixes #4384 .
2012-12-06 21:58:36 +01:00
Ben Noordhuis
b53cd9798f
doc: document setTimeout / setInterval behavior
2012-07-01 20:09:55 +02:00
Ben Kelly
c6185c8484
doc: Improve cross-linking in API docs markdown
...
Cross-link EventEmitter references in API docs to events.html
Fix broken cross-reference links with wrong anchor names in API docs.
2012-06-15 09:44:37 -07:00
Kyle Robinson Young
718aa505c4
doc: add require.extensions to globals
...
Closes #3028
2012-04-17 17:10:42 +02:00
isaacs
1d5b6f26fe
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
...
Conflicts:
ChangeLog
Makefile
deps/npm/AUTHORS
deps/npm/html/api/bin.html
deps/npm/html/api/bugs.html
deps/npm/html/api/commands.html
deps/npm/html/api/config.html
deps/npm/html/api/deprecate.html
deps/npm/html/api/docs.html
deps/npm/html/api/edit.html
deps/npm/html/api/explore.html
deps/npm/html/api/help-search.html
deps/npm/html/api/init.html
deps/npm/html/api/install.html
deps/npm/html/api/link.html
deps/npm/html/api/load.html
deps/npm/html/api/ls.html
deps/npm/html/api/npm.html
deps/npm/html/api/outdated.html
deps/npm/html/api/owner.html
deps/npm/html/api/pack.html
deps/npm/html/api/prefix.html
deps/npm/html/api/prune.html
deps/npm/html/api/publish.html
deps/npm/html/api/rebuild.html
deps/npm/html/api/restart.html
deps/npm/html/api/root.html
deps/npm/html/api/run-script.html
deps/npm/html/api/search.html
deps/npm/html/api/shrinkwrap.html
deps/npm/html/api/start.html
deps/npm/html/api/stop.html
deps/npm/html/api/submodule.html
deps/npm/html/api/tag.html
deps/npm/html/api/test.html
deps/npm/html/api/uninstall.html
deps/npm/html/api/unpublish.html
deps/npm/html/api/update.html
deps/npm/html/api/version.html
deps/npm/html/api/view.html
deps/npm/html/api/whoami.html
deps/npm/html/doc/README.html
deps/npm/html/doc/adduser.html
deps/npm/html/doc/bin.html
deps/npm/html/doc/bugs.html
deps/npm/html/doc/build.html
deps/npm/html/doc/bundle.html
deps/npm/html/doc/cache.html
deps/npm/html/doc/changelog.html
deps/npm/html/doc/coding-style.html
deps/npm/html/doc/completion.html
deps/npm/html/doc/config.html
deps/npm/html/doc/deprecate.html
deps/npm/html/doc/developers.html
deps/npm/html/doc/disputes.html
deps/npm/html/doc/docs.html
deps/npm/html/doc/edit.html
deps/npm/html/doc/explore.html
deps/npm/html/doc/faq.html
deps/npm/html/doc/folders.html
deps/npm/html/doc/help-search.html
deps/npm/html/doc/help.html
deps/npm/html/doc/index.html
deps/npm/html/doc/init.html
deps/npm/html/doc/install.html
deps/npm/html/doc/json.html
deps/npm/html/doc/link.html
deps/npm/html/doc/list.html
deps/npm/html/doc/npm.html
deps/npm/html/doc/outdated.html
deps/npm/html/doc/owner.html
deps/npm/html/doc/pack.html
deps/npm/html/doc/prefix.html
deps/npm/html/doc/prune.html
deps/npm/html/doc/publish.html
deps/npm/html/doc/rebuild.html
deps/npm/html/doc/registry.html
deps/npm/html/doc/removing-npm.html
deps/npm/html/doc/restart.html
deps/npm/html/doc/root.html
deps/npm/html/doc/run-script.html
deps/npm/html/doc/scripts.html
deps/npm/html/doc/search.html
deps/npm/html/doc/semver.html
deps/npm/html/doc/shrinkwrap.html
deps/npm/html/doc/star.html
deps/npm/html/doc/start.html
deps/npm/html/doc/stop.html
deps/npm/html/doc/submodule.html
deps/npm/html/doc/tag.html
deps/npm/html/doc/test.html
deps/npm/html/doc/uninstall.html
deps/npm/html/doc/unpublish.html
deps/npm/html/doc/update.html
deps/npm/html/doc/version.html
deps/npm/html/doc/view.html
deps/npm/html/doc/whoami.html
deps/npm/lib/install.js
deps/npm/lib/ls.js
deps/npm/man/man1/npm.1
deps/npm/man/man1/shrinkwrap.1
deps/npm/man/man3/npm.3
deps/npm/man/man3/shrinkwrap.3
deps/npm/node_modules/request/main.js
deps/npm/node_modules/request/package.json
deps/npm/package.json
deps/uv/src/unix/core.c
deps/v8/src/conversions-inl.h
deps/v8/src/elements.cc
deps/v8/src/version.cc
doc/about/index.html
doc/api/assert.markdown
doc/api/child_process.markdown
doc/api/cluster.markdown
doc/api/crypto.markdown
doc/api/debugger.markdown
doc/api/dgram.markdown
doc/api/dns.markdown
doc/api/documentation.markdown
doc/api/events.markdown
doc/api/fs.markdown
doc/api/globals.markdown
doc/api/http.markdown
doc/api/https.markdown
doc/api/modules.markdown
doc/api/net.markdown
doc/api/os.markdown
doc/api/path.markdown
doc/api/process.markdown
doc/api/querystring.markdown
doc/api/readline.markdown
doc/api/stdio.markdown
doc/api/stream.markdown
doc/api/timers.markdown
doc/api/tls.markdown
doc/api/tty.markdown
doc/api/url.markdown
doc/api/util.markdown
doc/api/vm.markdown
doc/api/zlib.markdown
doc/api_assets/style.css
doc/community/index.html
doc/index.html
doc/logos/index.html
doc/template.html
src/node_version.h
tools/doc/html.js
tools/gyp/test/mac/app-bundle/empty.c
2012-03-03 23:38:52 -08:00
isaacs
674416fbc9
s/buffers/buffer/
2012-02-29 16:04:55 -08:00
isaacs
a62ec4437b
doc refactor: globals
2012-02-29 16:04:51 -08:00
isaacs
f9e464f95a
s/buffers/buffer/
2012-02-27 11:14:38 -08:00
isaacs
af7314e190
doc refactor: globals
2012-02-27 11:14:34 -08:00
isaacs
1b5048b288
doc: refer to modules doc rather than src/node.js
2012-02-23 00:18:17 -08:00
Thomas Shinnick
4cf0ce5bb4
docs: typos and minor edits in several modules
...
Mostly quite minor edits. Those possibly of more interest are:
emitter.setMaxListeners(n)
That the limit is per event name for an emitter.
fs.readlink()
Not a path, but rather the symbolic link's string value, which
would be at best a partial path, certainly not a 'resolvedPath'
global.__filename
This may be "well-known" but this is a full path to the module
that referencing code is running in. It is not the main program's
path, unless you are in the main program. Each module knows only
its own path.
server.listen(port,...)
I actually needed this functionality... "gimme just _any_ next port"
stream.end()
stream.destroy()
Yeah, everybody knows what happens to the queued data, but let's
make it *really* explicit for the first readers.
2011-09-06 18:19:41 +02:00
koichik
3eb246485a
Doc improvements
2011-07-23 14:29:13 +09:00
AJ ONeal
eb7d762c55
Document that 'Buffer' is a global variable
2011-07-15 23:59:10 +02:00
AJ ONeal
8cc9ac0df2
added explanation of exports
...
Fixes #1075 .
2011-07-14 00:08:31 +09:00
Ryan Dahl
b96ae6674d
document require.cache
2011-06-03 08:14:35 +02:00
Ryan Dahl
d3d35ec3ca
add docs for console object
2011-04-18 16:52:53 -07:00
koichik
74d94b0dd1
Fix docs - Move module's description to right position
2011-04-14 14:40:50 -07:00
Ryan Dahl
d2298d225c
Add documentation around module.exports and scope of global objects
...
Closes GH-852.
2011-04-11 17:01:25 -07:00
Ryan Dahl
4877279efa
Add timers to globals section
...
Closes GH-864.
2011-04-01 09:19:08 -07:00
David Trejo
6788ad413f
See the <doc> section are now links to <doc>
...
Closes GH-839.
2011-03-28 15:53:17 -07:00
Ryan Dahl
86bf3309bf
docs: style
2011-01-17 13:35:30 -08:00
Ryan Dahl
a51063c13c
docs: Add note about global scope
2011-01-17 13:35:11 -08:00
isaacs
a2b3c865c9
Correct reference to "process.Module"
2010-11-23 14:09:59 -08:00
Micheil Smith
e190c9616e
Splitting documentation
2010-10-28 14:59:15 -07:00
