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

Complete doc overhaul #741

Merged

Conversation

lorenzwalthert
Copy link
Collaborator

@lorenzwalthert lorenzwalthert commented Feb 27, 2021

This PR improves documentation in various ways, in particular:

  • README:
    • moves adoption and examples out to vignettes.
    • move feature overview to intro vignette.
    • drop contributing guidelines.
    • updates badges (gh actions, travis appveyor etc).
    • add motivation
  • big review of intro to styler vignette and rebranding as 'Get started' article with direct link in navbar, in particular:
    • caching
    • stylerignore
    • dry mode
    • scope specification
    • alignment detection
  • caching and alignment: better cross-linking and documentation.
  • add vignette with examples for strict = FALSE.
  • add jupyter lab integration to adaption vignette.

vignettes/styler.Rmd Outdated Show resolved Hide resolved
vignettes/styler.Rmd Outdated Show resolved Hide resolved
vignettes/strict.Rmd Outdated Show resolved Hide resolved
vignettes/adoption.Rmd Outdated Show resolved Hide resolved
vignettes/adoption.Rmd Outdated Show resolved Hide resolved
Copy link
Contributor

@jonmcalder jonmcalder left a comment

Choose a reason for hiding this comment

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

I've suggested a few small changes but overall it looks good to me!

lorenzwalthert and others added 5 commits March 3, 2021 15:55
Co-authored-by: Jon Calder <jonmcalder@gmail.com>
Co-authored-by: Jon Calder <jonmcalder@gmail.com>
Co-authored-by: Jon Calder <jonmcalder@gmail.com>
Co-authored-by: Jon Calder <jonmcalder@gmail.com>
Co-authored-by: Jon Calder <jonmcalder@gmail.com>
@codecov-io
Copy link

codecov-io commented Mar 3, 2021

Codecov Report

Merging #741 (79cd848) into master (52b70fd) will increase coverage by 0.00%.
The diff coverage is 0.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #741   +/-   ##
=======================================
  Coverage   90.50%   90.51%           
=======================================
  Files          47       47           
  Lines        2381     2383    +2     
=======================================
+ Hits         2155     2157    +2     
  Misses        226      226           
Impacted Files Coverage Δ
R/nest.R 100.00% <ø> (ø)
R/style-guides.R 99.39% <ø> (ø)
R/ui-caching.R 100.00% <ø> (ø)
R/zzz.R 0.00% <0.00%> (ø)
R/stylerignore.R 100.00% <0.00%> (ø)

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 52b70fd...94741c3. Read the comment docs.

@lorenzwalthert lorenzwalthert merged commit 9d54e2e into r-lib:master Mar 3, 2021
@lorenzwalthert lorenzwalthert deleted the improve-intro-styler-vignette branch March 3, 2021 21:50
@lorenzwalthert
Copy link
Collaborator Author

Thanks @jonmcalder 🥳

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.

3 participants