[DOC]Fixed docstring ticks in documentation #2506
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses the issue of incorrect docstring ticks in the documentation. The changes include:
Corrected single backticks to triple backticks for code blocks to ensure proper formatting.
Updated the formatting for the following parameters to improve readability:
random_state: int or RandomState, default=None
Random seed or RandomState object.
n_jobs: int, default=1
The number of jobs to run in parallel. -1 means using all processors.
n_cases_: int
Number of train instances in data passed to fit.
Reference Issues/PRs:
Fixes #2434
What does this implement/fix? Explain your changes.
This PR corrects the docstring formatting to ensure that code blocks are displayed correctly in the documentation. The changes improve the overall readability and consistency of the docstrings.
Does your contribution introduce a new dependency? If yes, which one?
No
Any other comments?
Ensure that the formatting aligns with the project's documentation guidelines.
Reviewers, please verify the updated docstrings for accuracy.
PR checklist
The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation, or governance.
View the pull request
@contri