This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
[docs] Improve documentation of cli flag --project #3703
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current documentation of the cli flag `--project` is a little confusing as to which the path of a file or the path of a directory can be specified. As both are valid options, updating the documentation to make it clear that either the path to a `tsconfig.json` file or the path to a directory containing a `tsconfig.json` file can be specified.
|
Thanks for your interest in palantir/tslint, @a-xin! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request. |
a-xin
changed the title
johnwiseheart
approved these changes
Apr 5, 2018
HyphnKnight
pushed a commit
to HyphnKnight/tslint
that referenced
this pull request
Apr 9, 2018
The current documentation of the cli flag `--project` is a little confusing as to which the path of a file or the path of a directory can be specified. As both are valid options, updating the documentation to make it clear that either the path to a `tsconfig.json` file or the path to a directory containing a `tsconfig.json` file can be specified.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation of the cli flag
--projectis a little confusing as to which the path of a file or the path of a directory can be specified.As both are valid options, updating the documentation to make it clear that either the path to a
tsconfig.jsonfile or the path to a directory containing atsconfig.jsonfile can be specified.PR checklist
Overview of change:
Is there anything you'd like reviewers to focus on?
CHANGELOG.md entry: