Add documentation for MapboxDirectionsCLI tool #586
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
jill-cardamon
force-pushed
the
jill/cmdlineDocs-585
branch
from
b2deb17
to
f41916e
Compare
1ec5
reviewed
Nov 30, 2021
| @@ -687,6 +688,7 @@ | |||
| 8A41B0FC24F5C2390021FFDC /* CHANGELOG.md */, | |||
| 438BFEBC233D7FA900457294 /* Package.swift */, | |||
| 438BFEC0233D805500457294 /* README.md */, | |||
| C318CBE626E1B29400E42936 /* MapboxDirectionsCLI.md */, | |||
There was a problem hiding this comment.
Perhaps CommandLineTool.md would be more discoverable.
MapboxDirectionsCLI.md
Outdated
| # Mapbox Directions CLI | ||
|
|
||
| ## Getting Started | ||
| `MapboxDirectionsCLI` is a command line tool, designed to round-trip an arbitrary, JSON-formatted Directions or Map Matching API response through model objects and back to JSON. This is useful for various scenarios including testing purposes and designing more sophisticated API response processing pipelines. It is supplied as a Swift package. |
There was a problem hiding this comment.
“MapboxDirectionsCLI” isn’t a name we seem to be using anywhere from a user perspective.
Suggested change
| `MapboxDirectionsCLI` is a command line tool, designed to round-trip an arbitrary, JSON-formatted Directions or Map Matching API response through model objects and back to JSON. This is useful for various scenarios including testing purposes and designing more sophisticated API response processing pipelines. It is supplied as a Swift package. | |
| `mapbox-directions-swift` is a command line tool, designed to round-trip an arbitrary, JSON-formatted Directions or Map Matching API response through model objects and back to JSON. This is useful for various scenarios including testing purposes and designing more sophisticated API response processing pipelines. It is supplied as a Swift package. |
By the way, this description will need to be revisited as part of #576, which makes the tool into a more straightforward command-line version of normal usage of the library.
There was a problem hiding this comment.
I'll add a note to that pr as a reminder.
"MapboxDirectionsCLI" is the name of the target. We should change references to the tool to "mapbox-directions-swift" but keep references to "MapboxDirectionsCLI" for the build instructions.
README.md
Outdated
| @@ -217,6 +217,8 @@ To run (and build if it wasn't yet) `MapboxDirectionsCLI` and see usage: | |||
|
|
|||
| 1. `swift run mapbox-directions-swift -h` | |||
|
|
|||
| For further details, see the [MapboxDirectionsCLI documentation](ADD LINK). | |||
There was a problem hiding this comment.
Subject to the suggestion above:
Suggested change
| For further details, see the [MapboxDirectionsCLI documentation](ADD LINK). | |
| For further details, see the [MapboxDirectionsCLI documentation](MapboxDirectionsCLI.md). |
1ec5
approved these changes
Jan 18, 2022
jill-cardamon
force-pushed
the
jill/cmdlineDocs-585
branch
from
f2ff0a9
to
2e7146b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR fixes #585 by adding documentation for the MapboxDirectionsCLI tool.