User-facing api docs: utils: plotting, slack, threading, validator, zmq_helpers

[lakhotiaharshit]

Corrects user-facing API docs in utils.

• plotting
• slack
• threading
• validator
• zmq_helpers

@mention one core developer
@astafan8

[jenshnielsen]

Found a few small things

[codecov]

Codecov Report

Merging #1725 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1725      +/-   ##
==========================================
- Coverage   67.28%   67.28%   -0.01%     
==========================================
  Files         146      146              
  Lines       18138    18138              
==========================================
- Hits        12205    12204       -1     
- Misses       5933     5934       +1

[jenshnielsen]

I fixed a bunch of other small issues:

• Before Args: there should always be a blank line.
• Args: is a special section -> So you should not have stuff like Inherited Args (see validators.Ints)
• Context: should be in an Args section

A few more things that could be fixed

• The docstring for the baseclass here https://qcodes.github.io/Qcodes/api/utils/validators.html#qcodes.utils.validators.Validator does not render nicely
• Numbers https://qcodes.github.io/Qcodes/api/utils/validators.html#qcodes.utils.validators.Numbers is missing a intro part of the docstring and has a todo item

[jenshnielsen]

Could you also add a short docstring at the top of the module for validators.py

This will be rendered here https://qcodes.github.io/Qcodes/api/utils/index.html on the right side of the table

[jenshnielsen]

Thanks this looks great