-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS-1322: Suggest parameters, returns, descriptions for missing SDK methods #2087
DOCS-1322: Suggest parameters, returns, descriptions for missing SDK methods #2087
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you currently look for all objects that have the type "sig sig-object py"
. I think you could instead look for objects that have the class "py method"
. Then you know that the first child which also has the class "sig sig-object py"
is the object where you can get the id from. But, more importantly, the second child of that object has the description text. And then you can also get the parameters with their descriptions from that I think. Can you give that a go?
Nice, now do you think you could change the formatting of the output to resemble what the docs need so that it's a simple copy and paste task? |
@npentrel Tried to format it the best I can think of, LMK what you think! |
So this is an example of what you're getting as the output
I think pulling the pieces apart and adding the markup we need for the docs should work to create something like the following output. The close we can get to something we can just copy and paste and have it work, the better
|
Thank you, that makes sense! @npentrel I tried to update it to match your sample but this is the closest I could get it. They use relative links on the page and I couldn't figure out how to pull the method url precisely, tried a couple selectors, just looks like what we already have for ID so for URL I am using page url. That ok for now? |
Co-authored-by: Naomi Pentrel <[email protected]>
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2087/public |
Pulling more info automated