Docathon: Module level docs for Pulse#3849
Merged
mergify[bot] merged 5 commits intoFeb 18, 2020
Merged
Conversation
lcapelluto
added
the
documentation
lcapelluto
requested review from
DanPuzzuoli,
eggerdj,
nkanazawa1989 and
taalexander
as code owners
…ding autosummary references to important parts of the module that were previously unreachable, removing references to pieces that are mostly internal usage, and providing introductary summaries where appropriate
lcapelluto
force-pushed
the
docs/pulse-module-high-level-documentation
branch
from
6ca01aa to
83f4772
Compare
DanPuzzuoli
requested changes
Feb 14, 2020
Contributor
DanPuzzuoli
left a comment
DanPuzzuoli
left a comment
There was a problem hiding this comment.
These descriptions are really well written.
I added two text editing comments, and two comments for overzealous application of class linking.
Aside from these it looks great.
Helpful feedback from Dan, including more API cross referencing 🎉 Co-Authored-By: Daniel Puzzuoli <dan.puzzuoli@gmail.com>
DanPuzzuoli
approved these changes
Feb 18, 2020
Contributor
Author
|
Here is the follow up bug report: #3859 |
faisaldebouni
pushed a commit
to faisaldebouni/qiskit-terra
that referenced
this pull request
Aug 5, 2020
* Update the pulse module init file for documentation. This includes adding autosummary references to important parts of the module that were previously unreachable, removing references to pieces that are mostly internal usage, and providing introductary summaries where appropriate * Apply suggestions from code review Helpful feedback from Dan, including more API cross referencing 🎉 Co-Authored-By: Daniel Puzzuoli <dan.puzzuoli@gmail.com> * Small fixups * Another attempt to make linking work Co-authored-by: Daniel Puzzuoli <dan.puzzuoli@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update the pulse module init file for documentation. This includes adding autosummary references to important parts of the module that were previously unreachable, and providing introductory summaries where appropriate
This also closes #3406.
Details and comments
commandsmodule! (made an issue)Also: I will wait on #3838 to merge first, since I anticipate merge conflicts