question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Config object documentation is misleading

See original GitHub issue

In 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:closed
  • Created 9 years ago
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
jnwelzelcommented, Apr 4, 2016

@RangerMauve thank you, I’ll get to it then.

0reactions
RangerMauvecommented, Apr 4, 2016

Feel free to modify the source to have a default config object in there. 😄

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found