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

naming things #9

Closed
1 of 4 tasks
GregorDeCillia opened this issue Feb 8, 2021 · 1 comment · Fixed by #11
Closed
1 of 4 tasks

naming things #9

GregorDeCillia opened this issue Feb 8, 2021 · 1 comment · Fixed by #11
Assignees
Labels
docs Improvements or additions to documentation hard
Milestone

Comments

@GregorDeCillia
Copy link
Contributor

GregorDeCillia commented Feb 8, 2021

  • Make sure all function arguments use a consistent naming scheme.
  • Always use uris when ids are used as function arguments.
  • Namespace functions for specific endpoints by their endpoints (sc_table_saved-list())
  • Decide whether certain logic should be only accessible as a R6-method rather than a regular function
@GregorDeCillia GregorDeCillia added this to the Version 1.0 milestone Feb 8, 2021
@GregorDeCillia GregorDeCillia added hard docs Improvements or additions to documentation labels Feb 8, 2021
@GregorDeCillia GregorDeCillia self-assigned this Feb 8, 2021
@GregorDeCillia
Copy link
Contributor Author

About point 4: It is probably a good idea to make the parsers available both as functions and methods and use a consistent naming scheme. The logic should be implemented in the functions and the methods call the functions.

## methods without arguments
sc_table_meta(obj)
obj$meta

## methods with arguments
sc_table_field(obj, i)
obj$field(i)

This way, the functions can be developed and documented independently.

GregorDeCillia added a commit that referenced this issue Feb 15, 2021
@GregorDeCillia GregorDeCillia linked a pull request Aug 4, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation hard
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant