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

Tutorial should be conformed to the Spyder Docs style guide #7652

Closed
11 tasks done
CAM-Gerlach opened this issue Aug 8, 2018 · 0 comments
Closed
11 tasks done

Tutorial should be conformed to the Spyder Docs style guide #7652

CAM-Gerlach opened this issue Aug 8, 2018 · 0 comments

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Aug 8, 2018

Problem Description

As a follow-on to #7641 / #7643 we should have our tutorial match our docs by conforming to the same style guide, which will both further enhance its appearance and externel consistency, and also improve maintainability and internal consistency between them. Basic plan, inspiried by spyder-ide/spyder-docs#13 :

  • Harmonize line breaks to one per sentence to make both editing and reviewing changes much easier, and git much cleaner and more effective
  • Change implicit to explicit references
  • Use consistent marker characters, naming scheme, and structure for titles, headings and subheads
  • Harmonize formatting of elements/directives to conform to style guide
    • All bullets to *
    • i.e. -> i.e.
    • File names/paths
    • Keyboard shortcuts
    • GUI elements
    • Menu/preference selections
    • Code blocks
  • Restructure: Bullets vs. steps vs. prose
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants