Skip to content

Python: Document API graphs#5389

Merged
erik-krogh merged 10 commits into
github:mainfrom
tausbn:python-document-api-graphs
Mar 19, 2021
Merged

Python: Document API graphs#5389
erik-krogh merged 10 commits into
github:mainfrom
tausbn:python-document-api-graphs

Conversation

@tausbn
Copy link
Copy Markdown
Contributor

@tausbn tausbn commented Mar 11, 2021

Adds documentation for how to use API graphs. Note that some of this documentation refers to functionality that has not been merged yet (specifically #5388), and so this should not be merged yet.

Also, this builds on top of #5357, and so should probably not be reviewed until that PR has been merged.

@tausbn tausbn requested a review from a team as a code owner March 11, 2021 22:14
Copy link
Copy Markdown
Contributor

@yoff yoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great as is. I would like this PR to also insert a forward reference to using-api-graphs-in-python.rst into analysing-data-flow-in-python.rst at the point where the API module is first used. But since #5357 is perhaps not stable yet, we could also do that later..

@tausbn
Copy link
Copy Markdown
Contributor Author

tausbn commented Mar 12, 2021

Yeah, there are a few bits of connective tissue missing from this PR. I can add some of these bits now, as I think the corresponding parts in #5357 are sufficiently stable for that.

We'll need to do a second pass through the documentation once some of our changes hit LGTM.com (to add links to the query console), so I think it's okay for it to be not entirely complete at this point.

(I wrote the above several hours ago, but somehow didn't press the "Add comment" button. Whoops.)

@yoff yoff added the no-change-note-required This PR does not need a change note label Mar 15, 2021
@erik-krogh erik-krogh merged commit 7e9cf03 into github:main Mar 19, 2021
@tausbn tausbn deleted the python-document-api-graphs branch March 22, 2021 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation no-change-note-required This PR does not need a change note Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants