docs(datasets): fix optuna StudyDataset documentation page#1372
Open
gtauzin wants to merge 2 commits intokedro-org:mainfrom
Open
docs(datasets): fix optuna StudyDataset documentation page#1372gtauzin wants to merge 2 commits intokedro-org:mainfrom
gtauzin wants to merge 2 commits intokedro-org:mainfrom
Conversation
Convert StudyDataset class docstring from reStructuredText to Markdown to comply with the project's markdown-parseable docstring requirement. Changes: - Convert RST code-block directives to fenced Markdown code blocks - Convert RST link syntax to Markdown link syntax - Add try/except import in __init__.py for doc builds without optuna - Add standard title and description to the doc page Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
deepyaman
requested changes
Apr 6, 2026
Member
deepyaman
left a comment
deepyaman
left a comment
There was a problem hiding this comment.
Looks good, just a couple minor changes to the release notes.
| # Upcoming Release | ||
| ## Major features and improvements | ||
| ## Bug fixes and other changes | ||
| - Fixed `optuna.StudyDataset` documentation page by converting docstring from reStructuredText to Markdown and adding missing doc page header. |
Member
There was a problem hiding this comment.
This level of detail is not really relevant to a user. If anything, you can just say something like:
Suggested change
| - Fixed `optuna.StudyDataset` documentation page by converting docstring from reStructuredText to Markdown and adding missing doc page header. | |
| - Fixed the rendering of the `optuna.StudyDataset` documentation. | |
Or you can omit it altogether from the release notes (honestly, this would be my preference).
| ## Major features and improvements | ||
| ## Bug fixes and other changes | ||
| - Fixed `optuna.StudyDataset` documentation page by converting docstring from reStructuredText to Markdown and adding missing doc page header. | ||
| ## Community contributions |
Member
There was a problem hiding this comment.
Suggested change
| ## Community contributions | |
| ## Community contributions | |
| Many thanks to the following Kedroids for contributing PRs to this release: | |
| - [Guillaume Tauzin](https://github.com/gtauzin) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Ensure the optuna.StudyDataset docs renders properly.
Development notes
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-byline in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
jsonschema/kedro-catalog-X.XX.jsonif necessaryRELEASE.mdfile