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

Consistency in documentation fromat #8

Closed
bsiddiqui opened this issue Nov 23, 2013 · 2 comments
Closed

Consistency in documentation fromat #8

bsiddiqui opened this issue Nov 23, 2013 · 2 comments

Comments

@bsiddiqui
Copy link
Contributor

There are some places in the documentation where examples strings are used as arguments and others where the argument instructions are provided. In the example below "New Cool Posters" is an example string but "from-address-id," "to-address-id," etc are instructions for the expected argument. I think it would be better if the documentation was consistent in its format.

I'm happy to make a change for whichever is preferred (examples vs. argument instructions).

screenshot 2013-11-22 20 03 06

@HashNuke
Copy link
Contributor

I prefer having the the argument names as strings for certain examples. It makes the following things very clear:

  • The argument is an ID from the Lob.com system instead of a random string.
  • The argument is a string.

If you want it changed, can you provide an example? (I'm open to better stuff).

@HashNuke
Copy link
Contributor

Closing this issue for now. Feel free to re-open this when you feel there's something that needs to be fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants