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

Fix http links underscore #5513

Closed
y0z opened this issue Jun 24, 2024 · 2 comments · Fixed by #5514 or #5515
Closed

Fix http links underscore #5513

y0z opened this issue Jun 24, 2024 · 2 comments · Fixed by #5514 or #5515
Labels
contribution-welcome Issue that welcomes contribution. document Documentation related. good first issue Good first issue for contribution.

Comments

@y0z
Copy link
Member

y0z commented Jun 24, 2024

Motivation

In reStructuredText, one-off hyperlinks should be represented with two trailing underscores rather than a single trailing underscore that creates a reference.
However, in Optuna, some documents do not follow the rule.

Suggestion

Replace _ with __ in proper contexts.

Reference

@y0z y0z added document Documentation related. contribution-welcome Issue that welcomes contribution. good first issue Good first issue for contribution. labels Jun 24, 2024
@47aamir
Copy link
Contributor

47aamir commented Jun 24, 2024

trying it

@y0z
Copy link
Member Author

y0z commented Jun 25, 2024

Follow-up tasks remain.

#5515 (review)

Thank you for the PR, LGTM!

Followup (core developers will check if any lines are missing the same change)

  • faq.rst
  • terminator.py
  • optuna/visualization/_edf.py
  • optuna/visualization/matplotlib/_edf.py
  • optuna/visualization/matplotlib/_intermediate_values.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution-welcome Issue that welcomes contribution. document Documentation related. good first issue Good first issue for contribution.
Projects
None yet
3 participants