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

Reference: check_object missing explanation of two params #362

Open
adrian-datacamp opened this issue Oct 16, 2018 · 1 comment
Open

Reference: check_object missing explanation of two params #362

adrian-datacamp opened this issue Oct 16, 2018 · 1 comment
Labels

Comments

@adrian-datacamp
Copy link

The Reference article that covers check_function is missing explanations for

  • state=None
  • typestr='variable'
@hermansje
Copy link
Member

hermansje commented Oct 17, 2018

Thank you for reporting documentation improvements!

The first is the implicit state that is built up by traversing the code (as mentioned elsewhere on the reference page, you shouldn't set it manually).
The second is a template to build feedback messages (the construct 'the function ___ is missing' in feedback could be changed to 'the awesome function ___ is missing' using this parameter).

I'll close the issue once I clarified the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants