Skip to content

Docstrings updates for v10 #3121

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 37 commits into
base: SDKv10
Choose a base branch
from
Open

Docstrings updates for v10 #3121

wants to merge 37 commits into from

Conversation

@MichaelTrestman
Copy link
Contributor

@MichaelTrestman MichaelTrestman commented Oct 28, 2025

Welcome!

Due to GitHub limitations,
please switch to Preview for links to render properly.

Please choose the right template for your pull request:

@MichaelTrestman MichaelTrestman force-pushed the docstrings-updates-for-v10 branch from 269e0a3 to 5dded3d Compare November 5, 2025 23:12
@MichaelTrestman MichaelTrestman marked this pull request as ready for review November 17, 2025 18:53
@thewhaleking thewhaleking added the SDKv10 Use this label for issues and feature requests relevant to Bittensor SDK v10. label Nov 18, 2025
thewhaleking
thewhaleking reviewed Nov 18, 2025
View reviewed changes
Copy link
Contributor

@thewhaleking thewhaleking left a comment

Choose a reason for hiding this comment

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

Questions:

  1. why the double ":" in "Example::"?
  2. why the double backticks?
  3. Why the removal of most of the examples?

@basfroman
Copy link
Collaborator

basfroman commented Nov 18, 2025

Questions:

  1. why the double ":" in "Example::"?
  2. why the double backticks?
  3. Why the removal of most of the examples?

I guess this is Sphinx related things. @MichaelTrestman pls confirm or explain.
But I'd prefer to avoid this additional formatting.

@MichaelTrestman
Copy link
Contributor Author

MichaelTrestman commented Nov 19, 2025 •
edited
Loading

@thewhaleking @basfroman
Yes the formatting changes are to accomodate sphinx; I am still working through some formatting issues as well. Check out the rendered build: https://merged-sdk-edits-final.developer-docs-6uq.pages.dev/python-api/html/autoapi/bittensor/core/subtensor/

The examples I removed were ones that were kind of too minimal to be use, or if there is an extensive example at the link (actually I think I only removed minimal ones?).
Sorry for my slow response!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thewhaleking thewhaleking thewhaleking left review comments

@basfroman basfroman Awaiting requested review from basfroman

Assignees

No one assigned

Labels

SDKv10 Use this label for issues and feature requests relevant to Bittensor SDK v10.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@MichaelTrestman @basfroman @thewhaleking