Skip to content

Minor quicktour doc suggestions#236

Merged
lvwerra merged 1 commit into
mainfrom
quicktour-minor-fixes
Aug 15, 2022
Merged

Minor quicktour doc suggestions#236
lvwerra merged 1 commit into
mainfrom
quicktour-minor-fixes

Conversation

@stevhliu

@stevhliu stevhliu commented Aug 8, 2022

Copy link
Copy Markdown
Member

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

HuggingFaceDocBuilderDev commented Aug 8, 2022

Copy link
Copy Markdown

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

@lvwerra lvwerra left a comment

Copy link
Copy Markdown
Member

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.

3 participants