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.

Sign up for GitHub

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

Jump to bottom

Use consistent example names across all code samples #30

Open
spl opened this issue Oct 6, 2021 · 0 comments
Open

Use consistent example names across all code samples #30

spl opened this issue Oct 6, 2021 · 0 comments

Comments

@spl
Copy link
Contributor

spl commented Oct 6, 2021 •
edited
Loading

We should decide on a set of common example names to use in code examples for all of HTTP API, JavaScript, Python, TerminusX, etc. This includes at least:

  • example host endpoint for TerminusX API
  • example user name
  • example team name

I think it would also be nice to have an example access token that looks like a real access token but will never be one. This would be better than leaving it blank or using an ellipsis or something.
@spl spl changed the title Use common names: host, user, organization Use consistent example names across all code samples Nov 9, 2021
gitbook-com bot pushed a commit that referenced this issue Jan 9, 2022
@mark-terminusdb @gitbook-bot
GitBook: [#30] No subject
91ccff3
gitbook-com bot pushed a commit that referenced this issue Feb 16, 2022
@luke-feeney @gitbook-bot
GitBook: [#30] Added Public JSON-DP to Key Topics, included links to …
79257be 
…more info and examples using curl.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@spl