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

docs: document the approaches to API documentation to guide contributors #2938

Open
ossdhaval opened this issue Nov 9, 2022 · 0 comments
Open

docs: document the approaches to API documentation to guide contributors #2938

ossdhaval opened this issue Nov 9, 2022 · 0 comments
Assignees
@ossdhaval
Labels
area-documentation Documentation needs to change as part of issue or PR effort-2 Relative effort required for completion of issue or PR kind-enhancement Issue or PR is an enhancement to an existing functionality priority-5 Issue or PR addresses a very minor concern. Not planned for active development. Will not be fixed. triaged Issue or PR is fully triaged
Milestone
1.1.4

Comments

@ossdhaval
Copy link
Contributor

Describe the bug

We have decided to document APIs of different types in different ways. As discussed in this PR.

Add this to the contribution guide.
@ossdhaval ossdhaval added kind-enhancement Issue or PR is an enhancement to an existing functionality area-documentation Documentation needs to change as part of issue or PR effort-2 Relative effort required for completion of issue or PR priority-5 Issue or PR addresses a very minor concern. Not planned for active development. Will not be fixed. triaged Issue or PR is fully triaged labels Nov 9, 2022
@ossdhaval ossdhaval self-assigned this Nov 9, 2022
@ossdhaval ossdhaval mentioned this issue Nov 9, 2022
Merged
14 tasks
@moabu moabu added this to the 1.0.5 milestone Nov 14, 2022
@moabu moabu modified the milestones: 1.0.5, 1.0.6 Dec 1, 2022
@moabu moabu modified the milestones: 1.0.6, 1.0.7 Jan 9, 2023
@moabu moabu modified the milestones: 1.0.7, 1.0.9 Mar 1, 2023
@moabu moabu modified the milestones: 1.0.9, 1.0.10 Mar 9, 2023
@moabu moabu modified the milestones: 1.0.10, 1.0.11 Mar 16, 2023
@moabu moabu modified the milestones: 1.0.11, 1.0.12 Apr 5, 2023
@moabu moabu modified the milestones: 1.0.12, 1.0.13 Apr 18, 2023
@moabu moabu modified the milestones: 1.0.13, 1.0.14 May 10, 2023
@ossdhaval ossdhaval removed this from the 1.0.14 milestone May 22, 2023
@moabu moabu added this to the 1.0.16 milestone Jul 13, 2023
@moabu moabu modified the milestones: 1.0.16, 1.0.17 Aug 2, 2023
@ossdhaval ossdhaval modified the milestones: 1.0.17, 1.0.19 Aug 10, 2023
@moabu moabu modified the milestones: 1.0.19, 1.0.21 Nov 22, 2023
@moabu moabu modified the milestones: 1.0.21, 1.0.22 Dec 14, 2023
@moabu moabu modified the milestones: 1.0.22, 1.0.23 Feb 1, 2024
@moabu moabu modified the milestones: 1.1.0, 1.1.1 Mar 14, 2024
@moabu moabu modified the milestones: 1.1.1, 1.1.2 May 1, 2024
@moabu moabu modified the milestones: 1.1.2, 1.1.3 May 29, 2024
@moabu moabu modified the milestones: 1.1.3, 1.1.4 Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ossdhaval ossdhaval

Labels
area-documentation Documentation needs to change as part of issue or PR effort-2 Relative effort required for completion of issue or PR kind-enhancement Issue or PR is an enhancement to an existing functionality priority-5 Issue or PR addresses a very minor concern. Not planned for active development. Will not be fixed. triaged Issue or PR is fully triaged
Projects
None yet
Milestone
1.1.4
Development

No branches or pull requests
2 participants
@ossdhaval @moabu