cloudfoundry-community / cloudfoundry-community/node-cfenv
doc for isLocal property is wrong
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- CoffeeScript
- Stars
- 74
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- coffeescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100