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

Standard installation instruction visibility #979

Merged
merged 15 commits into from
Nov 20, 2024

Conversation

AntonNI8
Copy link
Contributor

@AntonNI8 AntonNI8 commented Nov 5, 2024

Context:
The standard (default, preferred) installation instructions in the pennylane-lightning docs are easy to miss.
This could discourage users if they think they need to go through a more involved installation process, ie. installing from source.

Description of the Change:
Added a heading for standard installation instructions.

Benefits:
Easier to notice the most simple/straightforward installation method for lightning devices.

Possible Drawbacks:

Related GitHub Issues:

@AntonNI8 AntonNI8 requested a review from DSGuala November 5, 2024 15:31
Copy link
Contributor

github-actions bot commented Nov 5, 2024

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.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.

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.70%. Comparing base (4c8d840) to head (6d8b6a8).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (4c8d840) and HEAD (6d8b6a8). Click for more details.

HEAD has 27 uploads less than BASE
Flag BASE (4c8d840) HEAD (6d8b6a8)
33 6
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #979       +/-   ##
===========================================
- Coverage   97.72%   28.70%   -69.03%     
===========================================
  Files         228       28      -200     
  Lines       36378     2505    -33873     
===========================================
- Hits        35550      719    -34831     
- Misses        828     1786      +958     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@AntonNI8 AntonNI8 added the documentation Improvements or additions to documentation label Nov 5, 2024
.github/CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@DSGuala DSGuala left a comment

Choose a reason for hiding this comment

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

Looks good to me. Approved pending

  1. Rebase to master
  2. Making sure there aren't any merge conflicts
  3. All tests pass

@AntonNI8 AntonNI8 changed the base branch from update_installation_instructions to master November 11, 2024 20:27
@AntonNI8
Copy link
Contributor Author

@maliasadi this PR should be good to go now, pending testing + your review

@AntonNI8 AntonNI8 requested a review from maliasadi November 15, 2024 21:11
Copy link
Member

@maliasadi maliasadi left a comment

Choose a reason for hiding this comment

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

Thanks @AntonNI8! Feel free to merge the PR after updating the changelog 🎉

.github/CHANGELOG.md Outdated Show resolved Hide resolved
.github/CHANGELOG.md Outdated Show resolved Hide resolved
@AntonNI8 AntonNI8 merged commit 9fc9633 into master Nov 20, 2024
69 of 70 checks passed
@AntonNI8 AntonNI8 deleted the preferred_installation_visibility branch November 20, 2024 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants