You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
Required fields*
- Is there any chance that any time in the future someone is going to need to ever use the underlying API along with your wrapper, or consult the underlying API documentation?DaveG– DaveG2020-03-15 20:52:50 +00:00Commented Mar 15, 2020 at 20:52
- @DaveG: Valid question, see edit.einpoklum– einpoklum2020-03-15 21:43:05 +00:00Commented Mar 15, 2020 at 21:43
- If it's merely a bolt-on to another API, and there isn't any independent reason to adjust the terminology (such as an integration with a second API that uses conflicting terms), then it'd be better to just belt up and run with the existing terminology.Steve– Steve2020-03-15 22:18:15 +00:00Commented Mar 15, 2020 at 22:18
- How about combining options 1 and 2 - stick with it, AND comment it?Robin Bennett– Robin Bennett2020-03-16 09:41:44 +00:00Commented Mar 16, 2020 at 9:41
- 1@RobinBennett: That is option 1. Of course if I stick with it I'll add a comment somewhere saying "this is the wrong thing to do, but".einpoklum– einpoklum2020-03-16 10:03:05 +00:00Commented Mar 16, 2020 at 10:03
| Show 1 more comment
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
- create code fences with backticks ` or tildes ~ ```
like so
``` - add language identifier to highlight code ```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_` - quote by placing > at start of line
- to make links (use https whenever possible) <https://example.com>[example](https://example.com)<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you