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.

Sign up for GitHub

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

Jump to bottom

Function documentation #209

Open
elinw opened this issue Apr 22, 2021 · 0 comments
Open

Function documentation #209

elinw opened this issue Apr 22, 2021 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@elinw
Copy link
Collaborator

elinw commented Apr 22, 2021

Qcoder has a lot of functions which, among other things, are designed to allow the use of command line to code and do other tasks. However, most of these are not fully documented. This issue is to provide the documentation and also to add examples to the documentation. This is important if we want to go on CRAN.
@elinw elinw added good first issue Good for newcomers help wanted Extra attention is needed labels Apr 22, 2021
changecase added a commit to changecase/qcoder that referenced this issue Jun 21, 2021
@changecase
Flesh out reference documentation for the parse_qcodes function
9112a9e 
Adds a bit more context to the parse_qcodes function documentation. We need more
complete documentation in order to publish to CRAN.

The updated documentation talks a little bit more about how this function works,
and provides a couple of examples.

I moved the majority of the description into the details. This makes the
description a bit more consise while preserving the details in the appopriately
named details section.

See: ropenscilabs#209
@changecase changecase mentioned this issue Jun 21, 2021
Merged
changecase added a commit to changecase/qcoder that referenced this issue Jun 22, 2021
@changecase
Flesh out reference documentation for the error_check function
edb35e9 
Adds context to the error_check function documentation. We need more complete documentation in order to publish to CRAN (ropenscilabs#209).

The updated documentation adds details, return values, and a couple of examples.

See: ropenscilabs#209
@changecase changecase mentioned this issue Jun 22, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@elinw