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.

Sign up for GitHub

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

Jump to bottom

Documentation: Search - indicator variable tooltip #1524

Closed
SarahG-579462 opened this issue Nov 14, 2023 · 1 comment · Fixed by #1527
Closed

Documentation: Search - indicator variable tooltip #1524

SarahG-579462 opened this issue Nov 14, 2023 · 1 comment · Fixed by #1527
Labels
bug Something isn't working docs Improvements to documenation indicators Climate indices and indicators

Comments

@SarahG-579462
Copy link
Contributor

SarahG-579462 commented Nov 14, 2023 •
edited
Loading

Generic Issue

  • xclim version: 0.46.0
  • Python version:
  • Operating System:

Description

The search button has the wrong tooltip for, for example, lat ("Latitude coordinate. If None and method in ["). This is because the documentation uses double-quotes, which are a special character in HTML. This also risks causing invalid webpages - thankfully it seems to display the page in firefox.

What I Did

https://xclim.readthedocs.io/en/stable/indicators.html and hover over lat variable for Biologically effective degree days

What I Received

<button class="indVarname" title="Latitude coordinate. If None and method in [" gladstones",="" "icclim"],="" a="" cf-conformant="" "latitude"="" field="" must="" be="" available="" within="" the="" passed="" dataarray."="" alt="Latitude coordinate. If None and method in [">lat</button>

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct
@SarahG-579462 SarahG-579462 added the docs Improvements to documenation label Nov 14, 2023
@SarahG-579462
Copy link
Contributor Author

haha, it also breaks the github markdown, fun.

@SarahG-579462 SarahG-579462 added bug Something isn't working indicators Climate indices and indicators labels Nov 14, 2023
@huard huard mentioned this issue Nov 14, 2023
Merged
5 tasks
huard added a commit that referenced this issue Nov 30, 2023
@huard
Escape HTML characters in the indicator search variable tooltip. (#1527)
2413df4 
<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #1524
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [ ] CHANGES.rst has been updated (with summary of main changes)
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

### What kind of change does this PR introduce?

* Adds a JS function to escape HTML characters.

### Does this PR introduce a breaking change?


### Other information:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working docs Improvements to documenation indicators Climate indices and indicators
Projects
xclim Documentation Overhaul
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Escape HTML characters in the indicator search variable tooltip. Ouranosinc/xclim
1 participant
@SarahG-579462