doc for isLocal property is wrong

Open Beginner friendly
#2 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
coffeescript
Domain
documentation

Research direction

Find the documentation for the isLocal property in the repository and compare its wording with the issue. Correct the description so it says false when a valid VCAP_APPLICATION environment variable is found and true otherwise. Verify that the generated or checked-in documentation contains the corrected text.

Written by the indexing model from the issue text.

Description

doc for isLocal is wrong:

isLocal: true if a valid VCAP_APPLICATION env var was found, false otherwise

should be:

isLocal: false if a valid VCAP_APPLICATION env var was found, true otherwise
Dominant language
CoffeeScript
Stars
74
Forks
25
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudfoundry-community/node-cfenv

All issues in cloudfoundry-community/node-cfenv

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.