Various parts of the Go client doc examples do not work with the existing API.

For example, https://pulsar.apache.org/docs/en/client-libraries-go/#producers 
is missing a Context
https://pulsar.apache.org/docs/en/client-libraries-go/#producer-operations more 
involved example refers to a message ID but the producer does not have that 
available.

Does anyone know a system that allows typechecking these docs?

I asked around and Rust puts markdown docs in code comments, with embedded code 
blocks in the markdown.  These get extracted and put into tests.  You can use # 
to hide boilerplate.

Javascript seems to have https://github.com/eslint/eslint-plugin-markdown

[ Full content available at: https://github.com/apache/pulsar/issues/2719 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org

Reply via email to