Config object documentation is misleading
See original GitHub issueIn the following config object, one would expect that the values there are the defaults. Except for the fact that defaults are specified for the last two, I would think nothing is amiss and would simply misunderstand your docs. This should be documentation, not an example. I recommend changing the values to their defaults. Example values are just confusing here. Remember documentation is no the same thing as examples.
var EventEmitter2 = require('eventemitter2').EventEmitter2;
var server = new EventEmitter2({
//
// use wildcards.
//
wildcard: true,
//
// the delimiter used to segment namespaces, defaults to `.`.
//
delimiter: '::',
//
// if you want to emit the newListener event set to true.
//
newListener: false,
//
// max listeners that can be assigned to an event, default 10.
//
maxListeners: 20
});
Issue Analytics
- State:
- Created 9 years ago
- Comments:5 (3 by maintainers)
Top Results From Across the Web
Am I missing something or is the Symfony Config component ...
Under Defining and Processing Configuration Values in the documentation for the Symfony Config component, it's implied that the root node name ...
Read more >1. ConfigObj 5 Introduction and Reference
ConfigObj - a Python module for easy reading and writing of config files. ... False for failed checks you get the actual error...
Read more >ConfigObject 1.2.2 documentation - PythonHosted.org
ConfigObject is a wrapper to the python ConfigParser to allow to access ... config = ConfigObject() >>> config.bools = dict(true=True, false=False).
Read more >Configuration — transformers 2.9.1 documentation
Behavior concerning key/value pairs whose keys are not configuration attributes is controlled by the return_unused_kwargs keyword parameter.
Read more >Config Reference — botocore 1.29.39 documentation
Advanced configuration for Botocore clients. ... Defaults to False. ... in all non-default values from the provided config and return a new config...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@RangerMauve thank you, I’ll get to it then.
Feel free to modify the source to have a default config object in there. 😄