Skip to content
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

Better docstrings for content.update #140

Closed
nealrichardson opened this issue Apr 1, 2024 · 3 comments · Fixed by #290
Closed

Better docstrings for content.update #140

nealrichardson opened this issue Apr 1, 2024 · 3 comments · Fixed by #290
Labels
documentation Improvements or additions to documentation sdk

Comments

@nealrichardson
Copy link
Collaborator

They're all pretty tautological, just restating the field name.

            name (str): The name of the content.
            title (Optional[str]): The title of the content.
            description (str): The description of the content.
            access_type (str): The access type of the content.
...

There's more useful information in the API docs, explaining what things are for, what valid values are, etc. We should grab those from the swagger spec and put them in there, translating to python as appropriate.

Probably also would be good to include xrefs to the hosted connect API docs for the relevant APIs.

@tdstein
Copy link
Collaborator

tdstein commented Apr 3, 2024

I've been going back and forth on whether to link directly to the API documentation. It's possible for the hosted documentation to diverge from the docstrings over time.

@tdstein
Copy link
Collaborator

tdstein commented Apr 3, 2024

Related to #135

@nealrichardson
Copy link
Collaborator Author

I've been going back and forth on whether to link directly to the API documentation. It's possible for the hosted documentation to diverge from the docstrings over time.

Possible but infrequent. We can also watch for changes in the API docstrings and make sure to copy them over. IMO the benefits of putting more detail in the SDK docs outweigh the cost of making sure they're accurate over time. I would be happy if no one other than us read the Connect API docs and they just read the SDK docs.

@tdstein tdstein added the documentation Improvements or additions to documentation label Apr 18, 2024
@tdstein tdstein added this to the 0.4.0 milestone Apr 26, 2024
@tdstein tdstein removed this from the 0.4.0 milestone Sep 4, 2024
@tdstein tdstein added the sdk label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation sdk
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants