Skip to content

DOC: Fix RandomWalk docstring formatting and kwargs #8075

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
Diegomed11 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DOC: Fix RandomWalk docstring formatting and kwargs #8075

Diegomed11 wants to merge 2 commits into from
+20 −2

Conversation

@Diegomed11
Copy link

@Diegomed11 Diegomed11 commented Jan 28, 2026

Description

This PR fixes formatting issues in the RandomWalk docstring as requested by @ricardoV94 in closed PR #8059.

Changes applied:

  • Moved the summary to the first line.
  • Fixed indentation of the parameter descriptions.
  • Added ** to kwargs to correctly indicate keyword arguments.
  • Pre-commit checks are passing.

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Diegomed11