Skip to content

Conversation

andf-viam
Copy link
Contributor

@andf-viam andf-viam commented Dec 8, 2023

Remove ModelAttributes from (docs.viam.com) SDK documentation.

  • Ticket asked for Python method removal, but Go method also present in docs; removed both (as it seems both have been removed from the code: former from Python SDK, latter from RDK in the first place!)

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 8, 2023
@viambot
Copy link
Member

viambot commented Dec 8, 2023

Overall readability score: 56.55 (🟢 +0)

File Readability
_index.md 65.51 (🟢 +0.09)
board.md 86.75 (🟢 +1.46)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
_index.md 65.51 46.57 7.97 13.9 12.41 5.45
  🟢 +0.09 🟢 +0.1 🟢 +0.04 🟢 +0 🟢 +0 🟢 +0
board.md 86.75 72.63 6.42 6 6.91 6.99
  🟢 +1.46 🟢 +0.21 🟢 +0.58 🟢 +0 🟢 +0.24 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.55 48.45 10.49 12.93 11.92 7.64
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@viambot
Copy link
Member

viambot commented Dec 8, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2313

@andf-viam
Copy link
Contributor Author

@penguinland Hi! Here's a docs update that appears to be as simple as it looks! Let me know if you'd like to see any changes -- thank you!

@andf-viam andf-viam requested a review from penguinland December 8, 2023 20:21
Copy link
Member

@penguinland penguinland left a comment

Choose a reason for hiding this comment

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

LGTM! The only thing that needs updating is my responsibility. 😖


**Returns:**

- [(Attributes)](https://python.viam.dev/autoapi/viam/components/board/index.html#viam.components.board.Board.Attributes): Attributes related to the model of this board.
Copy link
Member

Choose a reason for hiding this comment

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

👀 That link shouldn't exist any more but it does! and it does because I forgot to delete the Attributes class even though it's no longer used. I'll go make a follow-up PR, and when that's in, the docs at this link should automatically update to match. I'm glad I saw this and noticed my mistake.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh! No worries, thanks for catching -- and teaching me about the process!

Copy link
Member

Choose a reason for hiding this comment

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

Linking things up: the follow-up PR is viamrobotics/viam-python-sdk#501

penguinland added a commit to viamrobotics/viam-python-sdk that referenced this pull request Dec 8, 2023
This should have been removed in #491, but I forgot. It's dead code. Grepping the codebase for `Attributes` turns up only 1 result (in src/viam/errors.py), and that's a false positive.

Linking things up: I noticed this while reviewing viamrobotics/docs#2313
@andf-viam andf-viam merged commit de14fe4 into viamrobotics:main Dec 11, 2023
@andf-viam andf-viam deleted the DOCS-1464-remove-modelattributes branch December 11, 2023 17:45
njooma pushed a commit to viamrobotics/viam-python-sdk that referenced this pull request Dec 22, 2023
This should have been removed in #491, but I forgot. It's dead code. Grepping the codebase for `Attributes` turns up only 1 result (in src/viam/errors.py), and that's a false positive.

Linking things up: I noticed this while reviewing viamrobotics/docs#2313
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.

4 participants