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

Improve help documentation for cb_add_col_attributes #6

Closed
4 tasks done
mbcann01 opened this issue May 9, 2022 · 0 comments
Closed
4 tasks done

Improve help documentation for cb_add_col_attributes #6

mbcann01 opened this issue May 9, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mbcann01
Copy link
Member

mbcann01 commented May 9, 2022

Overview

At the very least, we need to document the five special attributes that cb_add_col_attributes() recognizes. Take directly from README.

The function documentation for cb_add_col_attributes() says nothing about the col_type attribute. True, it isn't a parameter, but it is a very important attribute. That needs to be may very clear. Probably in the ... section. We should probably also copy and paste some of the language from cb_add_summary_stats.

If you look at the cb_get_col_attributes() code, it looks like description, source, and col_type are attributes that aren't documented in cb_add_col_attributes(), but have special preference.

codebook()

Just needs to be way more descriptive. We should probably also copy and paste some of the language from cb_add_summary_stats.

Task list

@mbcann01 mbcann01 changed the title Improve function documentation Improve help documentation for cb_add_col_attributes Aug 10, 2022
@mbcann01 mbcann01 self-assigned this Aug 10, 2022
mbcann01 added a commit that referenced this issue Aug 10, 2022
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
Status: Done
Development

No branches or pull requests

1 participant