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

Improve quickstart - Introduction #2530

Merged
merged 12 commits into from
May 4, 2022
Merged

Improve quickstart - Introduction #2530

merged 12 commits into from
May 4, 2022

Conversation

mariaschuld
Copy link
Contributor

@mariaschuld mariaschuld commented May 2, 2022

This is the first of a series of PRs to make some temporary fixes to improve the outdated quickstarts, before they will face a more concerted upgrade.

Part I - Introduction

  • Rename to "in a nutshell"
  • Update text to be more general
  • Remove overview of other sections. They should have self-explanatory titles, instead of this hidden, hard-to-maintain section.

@github-actions
Copy link
Contributor

github-actions bot commented May 2, 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 May 2, 2022

Codecov Report

Merging #2530 (c568696) into master (e326486) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2530   +/-   ##
=======================================
  Coverage   99.53%   99.53%           
=======================================
  Files         243      243           
  Lines       19405    19405           
=======================================
  Hits        19314    19314           
  Misses         91       91           

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 e326486...c568696. Read the comment docs.

@mariaschuld mariaschuld requested a review from josh146 May 2, 2022 09:55
Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

Thanks @mariaschuld! This is a nice, clean update that is much better than the previous version. I only have minor comments regarding how we first position PL in the first few paragraphs

doc/introduction/pennylane.rst Outdated Show resolved Hide resolved
doc/introduction/pennylane.rst Outdated Show resolved Hide resolved
doc/introduction/pennylane.rst Show resolved Hide resolved
@mariaschuld mariaschuld requested a review from josh146 May 3, 2022 07:40
Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

Looks great!

doc/introduction/pennylane.rst Show resolved Hide resolved
doc/introduction/pennylane.rst Show resolved Hide resolved
@mariaschuld mariaschuld merged commit fb797be into master May 4, 2022
@mariaschuld mariaschuld deleted the improve_quickstart branch May 4, 2022 12:24
@mariaschuld mariaschuld restored the improve_quickstart branch May 12, 2022 13:06
@mariaschuld mariaschuld deleted the improve_quickstart branch May 12, 2022 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants