Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify require in examples #1136

Merged
merged 1 commit into from
Jan 7, 2020
Merged

Conversation

shadowspawn
Copy link
Collaborator

Pull Request

Problem

The require used for running examples directly in a git clone is different than in a normal program.

var program = require('../');

Solution

Add a commented out normal require and explanation:

// const program = require('commander'); // (normal include)
const program = require('../'); // include commander in git clone of commander repo

(Also switched from var to const in the older examples.)

- add commented out "normal" require
- add comment about local require
- remove low value "Module dependencies" comment
Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@abetomo abetomo merged commit e45ae5a into tj:develop Jan 7, 2020
@shadowspawn shadowspawn deleted the feature/update-examples branch January 7, 2020 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants