pythonwhat icon indicating copy to clipboard operation
pythonwhat copied to clipboard

Reference: check_object missing explanation of two params

Open adrian-datacamp opened this issue 7 years ago • 1 comments

The Reference article that covers check_function is missing explanations for

  • state=None
  • typestr='variable'

adrian-datacamp avatar Oct 16 '18 18:10 adrian-datacamp

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.

hermansje avatar Oct 17 '18 15:10 hermansje