feat(*): Allow multiple files to be used for parsing #9
Conversation
This file contains hidden or 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
| - Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`. Optionally, you can specify the path of the proposed endpoints docs using `--file-path` option like: | ||
| - Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`. Optionally, you can specify the path of the proposed endpoints docs using `--file-path` or `-f` option like: | ||
|
|
||
| ```pipenv run python serialize_data.py --file-path /pat/to/endpoints_data.json``` |
Owner
There was a problem hiding this comment.
I guess, the endpoints_data.json was wrong in this command earlier? It needed a .md file instead?
Author
There was a problem hiding this comment.
Yes. The last commit does that.
gutsytechster
force-pushed
the
allow_multiple_files
branch
from
6fdaf21 to
6bc7720
Compare
README.md
Outdated
|
|
||
| You can also provide multiple files as | ||
|
|
||
| ```pipenv run python serialize_data.py -f /path/to/proposed_endpoints.md -f path/to/another_proposed_endpoints.md``` |
Owner
There was a problem hiding this comment.
The docs does not have any mention for running like this:
pipenv run python serialize_data.py *.md
You've this format mentioned in the docstring though 🤔
Author
There was a problem hiding this comment.
Updated in the latest commit.
|
|
||
| If files resides at different paths, then you may provide them as positional argument to it. For e.g | ||
|
|
||
| ```pipenv run python serialize_data.py /path/to/some_file.md /path/to/another_file.md``` |
Owner
There was a problem hiding this comment.
Show in example that you meant another path ;)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This would allow multiple files to be used to generate the stub endpoints
json.