Skip to content

Commit

Permalink
Merge pull request #211 from y0z/feature/update-tutorial
Browse files Browse the repository at this point in the history
Add instrunctions not to use HTML tags in README.md
  • Loading branch information
nabenabe0928 authored Dec 17, 2024
2 parents a267f58 + 623ae33 commit 70c616b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 2 additions & 0 deletions recipes/002_registration.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@
- [Original Paper](Link/to/the/original/paper)
- [Source Code](Link/to/the/source/code)
Please do not use HTML tags in the README.md file. Only markdown is allowed. For security reasons, the HTML tags will be removed when the package is registered on the web page.
It is highly recommended that you confirm your package works properly (cf. :doc:`005_debugging`) before making a pull request.
Before making a pull request, please ensure the code examples in ``README.md`` and example.py do not contain your local directory and/or your fork of the registry.
Expand Down
8 changes: 5 additions & 3 deletions template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ license: "MIT License"
---
-->

Please read the [tutorial guide](https://optuna.github.io/optunahub-registry/recipes/001_first.html) to register your feature in OptunaHub.
You can find more detailed explanation of the following contents in the tutorial.
Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) will also help you.
Instruction (Please remove this instruction after you carefully read)

- Please read the [tutorial guide](https://optuna.github.io/optunahub-registry/recipes/001_first.html) to register your feature in OptunaHub. You can find more detailed explanation of the following contents in the tutorial.
- Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) would also be helpful.
- **Please do not use HTML tags in the `README.md` file. Only markdown is allowed. For security reasons, the HTML tags will be removed when the package is registered on the web page.**

## Abstract

Expand Down

0 comments on commit 70c616b

Please sign in to comment.