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

Add design principles vignette #38

Merged
merged 22 commits into from
May 15, 2024
Merged

Add design principles vignette #38

merged 22 commits into from
May 15, 2024

Conversation

jamesmbaazam
Copy link
Member

@jamesmbaazam jamesmbaazam commented Jul 26, 2023

This PR closes #34 by adding a design vignette to the package website.

@jamesmbaazam jamesmbaazam self-assigned this Jul 26, 2023
@jamesmbaazam jamesmbaazam added the documentation Improvements or additions to documentation label Jul 26, 2023
@jamesmbaazam jamesmbaazam marked this pull request as ready for review July 26, 2023 18:10
@jamesmbaazam jamesmbaazam requested a review from sbfnk July 26, 2023 18:10
@jamesmbaazam jamesmbaazam marked this pull request as draft September 22, 2023 10:40
@jamesmbaazam jamesmbaazam force-pushed the add_design_doc branch 2 times, most recently from 8d70caa to 2329fa3 Compare December 15, 2023 22:31
@jamesmbaazam jamesmbaazam marked this pull request as ready for review December 15, 2023 22:34
@jamesmbaazam jamesmbaazam marked this pull request as draft December 15, 2023 22:34
@jamesmbaazam jamesmbaazam reopened this Dec 15, 2023
@codecov-commenter
Copy link

codecov-commenter commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.78%. Comparing base (5e6fd49) to head (5eed429).

❗ Current head 5eed429 differs from pull request most recent head 52e6642. Consider uploading reports for the commit 52e6642 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #38   +/-   ##
=======================================
  Coverage   98.78%   98.78%           
=======================================
  Files           8        8           
  Lines         574      574           
=======================================
  Hits          567      567           
  Misses          7        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jamesmbaazam jamesmbaazam marked this pull request as ready for review March 8, 2024 15:23
@jamesmbaazam jamesmbaazam changed the title Add draft of design document Add design document Mar 8, 2024
@jamesmbaazam jamesmbaazam changed the title Add design document Add design principles vignette Mar 8, 2024
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

This is great! Only some small suggestions.

As a general point for text-based files such as this one or .tex files I'm a big fan of the "one line per sentence" (rather than 80 character cutoff) format as it makes changes easier to apply/visualise in a diff-based interface such as the one used by github. But everyone has different preferences/editors etc. so I don't think there's a hard and fast rule.

vignettes/design-principles.Rmd Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
@jamesmbaazam
Copy link
Member Author

I'm a big fan of the "one line per sentence" (rather than 80 character cutoff) format as it makes changes easier to apply/visualise in a diff-based interface such as the one used by github. But everyone has different preferences/editors etc. so I don't think there's a hard and fast rule.

Thanks. It's a good point. I'll do that in the future and make sure R Studio wraps it (for me) to make it easier to work with.

@jamesmbaazam
Copy link
Member Author

Merging this as it has already been reviewed.

@jamesmbaazam jamesmbaazam merged commit f466e4b into main May 15, 2024
8 checks passed
@jamesmbaazam jamesmbaazam deleted the add_design_doc branch May 15, 2024 15:51
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.

Add package design vignette
4 participants