update the documentation to code-quote the params. plus, add the param type