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

DOC: Example one-liners #41

Merged
merged 1 commit into from
Mar 9, 2016
Merged

DOC: Example one-liners #41

merged 1 commit into from
Mar 9, 2016

Conversation

jmunoznaranjo
Copy link
Contributor

Command examples are provided to serve as a quick use manual.

  • Examples.md: add the command examples
  • README.md: link Examples.md

@adrienverge
Copy link
Contributor

Great! 👍

@ghost
Copy link

ghost commented Feb 22, 2016

👍 A much needed documentation, thanks!

@LaureVergeron
Copy link

(minor update for layout, @jmunoznaranjo : confirm with me we're good?)

@adrienverge
Copy link
Contributor

Still 👍 for me


##### for an account

Creation for account TestAccount (request authenticated with this key will
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's a typo here introduced by myself: 'request' should be in plural.

@LaureVergeron since you're adding extra stuff can you please fix this?

Choose a reason for hiding this comment

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

done

@NicolasT
Copy link

Did you consider whether there's a way to 'test' the commands (and results) used in this document, to ensure it remains consistent with whichever future changes to the tools CLI, API,...?

 Command examples are provided to serve as a quick use manual.

 - Examples.md: add the command examples
 - README.md: link Examples.md
@jmunoznaranjo
Copy link
Contributor Author

@NicolasT That's a good point, I just opened an issue. Any suggestion?

#49

jmunoznaranjo added a commit that referenced this pull request Mar 9, 2016
@jmunoznaranjo jmunoznaranjo merged commit eac6fd5 into rel/1.0 Mar 9, 2016
@jmunoznaranjo jmunoznaranjo deleted the DOC/examples branch March 9, 2016 10:35
@jmunoznaranjo jmunoznaranjo mentioned this pull request Mar 9, 2016
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.

4 participants