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

Categorize documentation under programmer interface #1465

Closed
kunaltyagi opened this issue Jan 20, 2021 · 1 comment
Closed

Categorize documentation under programmer interface #1465

kunaltyagi opened this issue Jan 20, 2021 · 1 comment

Comments

@kunaltyagi
Copy link

Interface: can be a language (like Python or JS), or program API (eg: Docker) or something else

Sometimes, I feel like finding what other popular and good documentation are there for certain interface. This will help collapse interfaces that aren't needed and focus on finding documentation in the ones that are available.

Manually typing to enable takes more effort that scrolling and reading the alphabetized list quickly. Unfortunately, different language based libraries are mixed together. Some of them are polyglot libraries, making it harder to guess if they'd have you interface, resulting in decreased happiness.

This is vital when I move to a new code-base in a language that I haven't used for a while. Grok around the code for a while, get the documentations for all the weird keywords that feel vaguely familiar and then get to work :)

@simon04
Copy link
Contributor

simon04 commented Jan 20, 2021

Duplicate of #4

@simon04 simon04 marked this as a duplicate of #4 Jan 20, 2021
@simon04 simon04 closed this as completed Jan 20, 2021
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

No branches or pull requests

2 participants