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

Minor quicktour doc suggestions #236

Merged
merged 1 commit into from
Aug 15, 2022
Merged

Minor quicktour doc suggestions #236

merged 1 commit into from
Aug 15, 2022

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented Aug 8, 2022

This PR proposes some minor formatting suggestions to the quicktour 🙂

  • Some code examples that don't start with >>> don't get copied except for the output.
  • Added a link to pipeline and combine so users can click for more details.
  • Code format isn't rendered in the right navbar and shows up with the backticks. It might look nicer if we rename the section header or just remove the backticks.

This PR adds some minor formatting suggestions to the quicktour 🙂

- Some code examples that don't start with `>>>` don't get copied except for the output.
- Added a link to `pipeline` and `combine` so users can click for more details.
- Code format isn't rendered in the right navbar and shows up with the backticks. It might look nicer if we rename the section header or just remove the backticks.
@stevhliu stevhliu added the documentation Improvements or additions to documentation label Aug 8, 2022
@stevhliu stevhliu requested a review from lvwerra August 8, 2022 22:33
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Aug 8, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Member

@lvwerra lvwerra left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @stevhliu!

@lvwerra lvwerra merged commit 3067ef3 into main Aug 15, 2022
@lvwerra lvwerra deleted the quicktour-minor-fixes branch August 15, 2022 12:00
mathemakitten pushed a commit that referenced this pull request Aug 15, 2022
This PR adds some minor formatting suggestions to the quicktour 🙂

- Some code examples that don't start with `>>>` don't get copied except for the output.
- Added a link to `pipeline` and `combine` so users can click for more details.
- Code format isn't rendered in the right navbar and shows up with the backticks. It might look nicer if we rename the section header or just remove the backticks.
mathemakitten pushed a commit that referenced this pull request Sep 23, 2022
This PR adds some minor formatting suggestions to the quicktour 🙂

- Some code examples that don't start with `>>>` don't get copied except for the output.
- Added a link to `pipeline` and `combine` so users can click for more details.
- Code format isn't rendered in the right navbar and shows up with the backticks. It might look nicer if we rename the section header or just remove the backticks.
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.

None yet

3 participants