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 documentation warnings and errors #994

Merged
merged 25 commits into from
Oct 30, 2024
Merged

Fix documentation warnings and errors #994

merged 25 commits into from
Oct 30, 2024

Conversation

jesper-friis
Copy link
Collaborator

@jesper-friis jesper-friis commented Oct 28, 2024

Description

Fix most warnings and errors from doxygen and sphinx.

Improved generated documentation.

Type of change

  • Bug fix & code cleanup
  • New feature
  • Documentation update
  • Test update

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

  • Is the change limited to one issue?
  • Does this PR close the issue?
  • Is the code easy to read and understand?
  • Do all new feature have an accompanying new test?
  • Has the documentation been updated as necessary?

@jesper-friis jesper-friis marked this pull request as draft October 28, 2024 18:21
@jesper-friis jesper-friis marked this pull request as ready for review October 28, 2024 21:46
jesper-friis and others added 3 commits October 30, 2024 15:01
Co-authored-by: Francesca L. Bleken <[email protected]>
Co-authored-by: Francesca L. Bleken <[email protected]>
Co-authored-by: Francesca L. Bleken <[email protected]>
Comment on lines 69 to 70
- Starts with '@': object is a language-tagged plain literal.
The language identifier follows the '@'-sign. e.g. `text@en`
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not clear.
Do we write ´o='text', d='@en'´ or ´d='test@en´? As I suggested in my previous comment I think my example is not completely correct.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You are right. It should be ´o='text', d='@en'´. Corrected the example

@jesper-friis jesper-friis linked an issue Oct 30, 2024 that may be closed by this pull request
@jesper-friis jesper-friis enabled auto-merge (squash) October 30, 2024 16:29
@jesper-friis jesper-friis merged commit 62c26ee into master Oct 30, 2024
14 checks passed
@jesper-friis jesper-friis deleted the fix-docs-errors branch October 30, 2024 16:33
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.

Fix warnings and errors from Doxygen and Sphinx
2 participants