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

Docs rendering #645

Merged
merged 1 commit into from
Mar 24, 2024
Merged

Docs rendering #645

merged 1 commit into from
Mar 24, 2024

Conversation

FBruzzesi
Copy link
Collaborator

Description

Found a few others rendering issues in the docs. Apparently mkdocs material admonitions do not render between keyword sections of mkdocstring (Parameters, Attributes,..).

I am moving those to the top level description.

@@ -253,6 +253,14 @@ Now let's see what occurs when we add a constraint that enforces the feature to

If these features are now passed to a model that supports monotonicity constraints then we can build models with guarantees.

## Outlier Removal
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This can be postponed after we decide for #643

Comment on lines -106 to +100
Notes
-----
See [`sklearn.pipeline.Pipeline`](https://scikit-learn.org/stable/modules/generated/sklearn.pipeline.Pipeline.html#sklearn.pipeline.Pipeline)
for all other variables.
for all other parameters other than `log_callback`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was getting a weird nesting :|

Comment on lines +23 to +25

Example
-------
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Moved the example to top level as in other classes

@FBruzzesi FBruzzesi merged commit d7ae46c into koaning:main Mar 24, 2024
17 checks passed
@FBruzzesi FBruzzesi deleted the patch/docs-rendering branch March 24, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants