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

Adopt/Confirm 7 Principles of Scannable Function Specs #26

Open
jmlondon opened this issue Sep 17, 2023 · 0 comments
Open

Adopt/Confirm 7 Principles of Scannable Function Specs #26

jmlondon opened this issue Sep 17, 2023 · 0 comments

Comments

@jmlondon
Copy link
Owner

From the posit::conf 2023 'Package Development Masterclass' and tidy design principles for package development, the following 7 principles were presented:

  1. Make arguments explicit
  2. Put the most important arguments first
  3. Required arguments shouldn't have defaults
  4. Put ... after required arguments
  5. Keep defaults short and sweet
  6. Enumerate possible options
  7. Reduce clutter with an options object

1 thru 5 should be pretty straightforward to adopt; 6 & 7 will take some thought and effort.

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

No branches or pull requests

1 participant