Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Provide more examples in API documentation comments #113

Closed
cgranade opened this issue May 24, 2019 · 3 comments
Closed

Provide more examples in API documentation comments #113

cgranade opened this issue May 24, 2019 · 3 comments
Assignees
@cgranade @bettinaheim
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Enhancement New feature or request
Milestone
On Deck

Comments

@cgranade
Copy link
Contributor

In general, the API documentation pages for the Q# libraries are fairly light on examples. Adding more /// # Example sections would help make the libraries more accessible and easier to use.
@cgranade cgranade added Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Enhancement New feature or request labels Jun 21, 2019
@cgranade cgranade added this to the On Deck milestone Jul 11, 2019
@cgranade cgranade mentioned this issue Aug 14, 2019
Closed
@bromeg bromeg mentioned this issue Aug 29, 2019
Closed
@cgranade cgranade mentioned this issue Jan 23, 2020
Closed
9 tasks
@cgranade cgranade added the good first issue Good for newcomers label Mar 25, 2020
@guenp
Copy link
Contributor

guenp commented Nov 23, 2020

This is a good idea but the issue is a bit too general for us to actually get started on this.
My suggestions for action items:

  • Create a new issue to add examples to one or two frequently used namespaces
  • Explicitly make examples part of the Q# Libraries API proposal template.
  • Close this issue

Tagging @cgranade @msoeken

@guenp
Copy link
Contributor

guenp commented Nov 23, 2020

Interesting find when @msoeken were looking into the docs: MicrosoftDocs/quantum-docs-pr#1121

@guenp guenp removed the good first issue Good for newcomers label Nov 23, 2020
@msoeken
Copy link
Member

msoeken commented Apr 27, 2022

Closing as duplicate to #339

@msoeken msoeken closed this as completed Apr 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@cgranade cgranade

@bettinaheim bettinaheim

Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Enhancement New feature or request
Projects
None yet
Milestone
On Deck
Development

No branches or pull requests
4 participants
@cgranade @msoeken @guenp @bettinaheim