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

Improve documentation of NumPy module #2179

Merged
merged 7 commits into from
Feb 9, 2022
Merged

Improve documentation of NumPy module #2179

merged 7 commits into from
Feb 9, 2022

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Feb 8, 2022

Context: The NumPy module was not included in the API documentation.

Description of the Change:

  • Include the NumPy module in the API documentation
  • Improve docstrings

Benefits: Better documentation

Possible Drawbacks: n/a

Related GitHub Issues: Fixes #2175

@josh146 josh146 added documentation 📘 Documentation changes and updates review-ready 👌 PRs which are ready for review by someone from the core team. labels Feb 8, 2022
@josh146 josh146 requested a review from dime10 February 8, 2022 08:18
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2022

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@codecov
Copy link

codecov bot commented Feb 8, 2022 •
edited
Loading

Codecov Report

Merging #2179 (3cdc8df) into master (e44ea0d) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2179      +/-   ##
==========================================
- Coverage   99.20%   99.20%   -0.01%     
==========================================
  Files         231      231              
  Lines       17784    17783       -1     
==========================================
- Hits        17643    17642       -1     
  Misses        141      141
Impacted Files Coverage Δ
pennylane/numpy/__init__.py 100.00% <ø> (ø)
pennylane/numpy/wrapper.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e44ea0d...3cdc8df. Read the comment docs.

@josh146 josh146 mentioned this pull request Feb 8, 2022
Closed
dime10
dime10 approved these changes Feb 9, 2022
View reviewed changes
Copy link
Contributor

@dime10 dime10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea @josh146, I love this one 🎉 🎉 🎉

pennylane/numpy/wrapper.py Outdated Show resolved Hide resolved
pennylane/numpy/wrapper.py Outdated Show resolved Hide resolved
josh146 and others added 2 commits February 9, 2022 12:41
@josh146
Merge branch 'master' into numpy-docs
085792f
@josh146 @dime10
Apply suggestions from code review
3cdc8df 
Co-authored-by: David Ittah <dime10@users.noreply.github.com>
@josh146
Copy link
Member Author

josh146 commented Feb 9, 2022

Thanks @dime10, I find documentation PRs very cathartic these days 😆

@josh146 josh146 merged commit b284670 into master Feb 9, 2022
@josh146 josh146 deleted the numpy-docs branch February 9, 2022 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dime10 dime10 dime10 approved these changes

Assignees
No one assigned
Labels
documentation 📘 Documentation changes and updates review-ready 👌 PRs which are ready for review by someone from the core team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve documentation of numpy interface
2 participants
@josh146 @dime10