Make Use case examples reachable from API Documentation
See original GitHub issueI’m submitting a…
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
Current behavior
There no way to get example use case for Class/Function/Decorator
from API documentation
Expected behavior
There Should be a link from API Documentation to Tutorial/Fundamentals/Techniques section (maybe vise versa) To show example use cases
Example
@HostListener Documentation can have link to this page
What is the motivation / use case for changing the behavior?
Most of times developers know that certain thing can help with some use case and they look up in API documentation but example use case can give insights on how to use it
Issue Analytics
- State:
- Created 6 years ago
- Reactions:1
- Comments:5 (4 by maintainers)
Top Results From Across the Web
The Function of API Use Cases & Case Studies on Developer ...
Should use cases and case studies be part of your API documentation? They play two crucial roles on a developer portal: They act...
Read more >API Documentation Guide and Best Practices - Stoplight
In this API documentation guide, we'll cover the basics of how to document APIs and different types of documentation. Create API Documentation.
Read more >Common Use Case Example | Google Ads API
We now take a look at a common use case: summarizing the performance of an account over the last 30 days by campaign,...
Read more >3 Best Practices for API Documentation - Pandium
API documentation generally includes descriptions of your API functionality, references, instructions for implementation, and use case examples.
Read more >Getting Started With Use Case Modeling - Oracle
Write preconditions as a set of assertions, for example “User is logged on”, “Credit Card has been validated” and so on. Consider putting...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
There is an
@see
tag that can be used to refer to relevant guides/guide sections, as well as to related API elements. I am recommending that people use it.This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.