Fix autoinstrumentation docs #544
Conversation
mauriciovasquezbernal
changed the title
|
I'll wait for a decision on #547 before performing further updates to this PR. |
There was a problem hiding this comment.
I added a commit with a couple fixes and one update that takes #567 into consideration, feel free to take it into consideration, @mauriciovasquezbernal 👍
|
|
||
| As you can see, both outputs are equivalent since the automatic | ||
| instrumentation does what the manual instrumentation does too. | ||
|
|
There was a problem hiding this comment.
Should we add more advanced uses cases here? For example passing in configuration arguments in instrument.
- Convert file to rst to be included in the generated documentation - Include docs for main module. - Use internal reference instead of read the docs link
|
I wanted to fix this as part of #547, but that will take longer than expected. Given that:
I'd propose to merge this PR that is just changing the file format + fixing some small issues. Further modifications to the content itself could be done in follow up PRs. @toumorokoshi what do you think? Btw, I got so many conflicts that I decided to start from scratch and force pushed to this PR. |
- Convert file to rst to be included in the generated documentation - Include docs for main module. - Use internal reference instead of read the docs link
Two small fixes for autoinstrumentation docs.