Skip to content

DOCS-3866: Update Python SDK doc to reflect BinaryID deprecation #4251

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nathan-contino
Copy link
Contributor

  • BinaryID was recently deprecated. This updates the generated Python SDK docs to reflect that deprecation, among other changes, such as those in Update data client SDK docs to better reflect Binary ID deprecation, also spring cleaning viam-python-sdk#913 (mostly cleanup, typo fixes, etc) and others since the last generated doc deploy.
  • I'm not sure why running the SDK docs scraping script has trimmed so many \ characters. As far as I can tell, they're unnecessary escape characters that we don't need, so they don't matter. Maybe the script changed since the last generated doc deploy?
  • In working on this ticket, I identified that the scraping script doesn't handle scraping a few bits of markup correctly from docstrings. We lose bold, monospace, and italic text entirely. "Returns" and "Parameters" sections don't support bulleted lists. Some links lose their pretty text. I'm going to chalk that up as 'scope creep' and look the other way for now, but I hope to make some infra improvements to .github/workflows/update_sdk_methods.py eventually.
  • This error should be fixed, but I'm not sure how we've handled it in the past:
ERROR Link text is too non-descriptive: "https://pointclouds.org/documentation/tutorials/pcd_file_format.html"

Basically, a dev put a raw URL in a docstring, and Hugo complained because it wasn't decorated with text. I've PR'ed a fix in the linked PR, but I'm not sure when that will make it in, so keep an eye out for this in the future. I suspect we could also update the scraping script to better handle this case, and automagically use the URL itself as text to stop Hugo complaints over something we can't directly control.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 25, 2025
Copy link

netlify bot commented Apr 25, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 46ecfa1
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/680bed73c3c1e50008f45055
😎 Deploy Preview https://deploy-preview-4251--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 37 (🔴 down 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@JessamyT JessamyT left a comment

Choose a reason for hiding this comment

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

LGTM % from-upstream-typo that I commented on in upstream PR ("forthe"). But I want to hear Naomi's responses to your comments when she comes back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants