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

Swap contents for HTMLString and MarkdownString in docs #2110

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Swap contents for HTMLString and MarkdownString in docs #2110

merged 1 commit into from
Dec 5, 2023

Conversation

christianversloot
Copy link
Contributor

Describe changes

The docs accidentally give a Markdown example for HTMLString and an HTML example for MarkdownString. This PR fixes that.

* zenml.types.HTMLString for strings in HTML format, e.g., "# Header\nSome text",
* zenml.types.MarkdownString for strings in Markdown format, e.g., "<h1>Header</h1>Some text",

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • If I have added an integration, I have updated the integrations table and the corresponding website section.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@strickvl
Copy link
Contributor

strickvl commented Dec 5, 2023

Good catch. Thanks for the PR, @christianversloot!

@strickvl strickvl added the documentation Improvements or additions to documentation label Dec 5, 2023
@strickvl strickvl merged commit 812e82e into zenml-io:develop Dec 5, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants