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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

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 ✅

Please upload report for BASE (update_installation_instructions@d95fe53). Learn more about missing BASE report.

Additional details and impacted files
@@                         Coverage Diff                         @@
##             update_installation_instructions     #979   +/-   ##
===================================================================
  Coverage                                    ?   28.57%           
===================================================================
  Files                                       ?       28           
  Lines                                       ?     2495           
  Branches                                    ?        0           
===================================================================
  Hits                                        ?      713           
  Misses                                      ?     1782           
  Partials                                    ?        0           

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

@AntonNI8 AntonNI8 added the documentation Improvements or additions to documentation label Nov 5, 2024
Comment on lines 126 to 127
* Update Lightning-Tensor installation docs and usage suggestions.
[(#979)](https://github.com/PennyLaneAI/pennylane-lightning/pull/979)
Copy link
Member

Choose a reason for hiding this comment

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

Hi @AntonNI8, what's the status of this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @maliasadi , I just wanted to make some tweaks to the installation instructions for the lightning devices, but figured it would be best to wait until all of the v0.39 release work had been completed.
Pending reviews, I think we can go ahead with it.

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
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