Skip to content

[BUG] The synopsis part of myloader documentation looks odd #6

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

Open
anttilaiti opened this issue May 27, 2024 · 1 comment
Open

[BUG] The synopsis part of myloader documentation looks odd #6

anttilaiti opened this issue May 27, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@anttilaiti
Copy link

Describe the bug
The "Synopsis" part in myloader documentation looks odd. In raw it is :program:`myloader` :option:`--directory <myloader --directory>` = /path/to/mydumper/backup [:ref:`OPTIONS <myloader-options-label>`] and in GitHub UI it is myloader --directory <myloader --directory> = /path/to/mydumper/backup [OPTIONS <myloader-options-label>

To Reproduce
View the myloader documentation

Expected behavior
Probably it should look something like myloader --directory=/path/to/mydumper/backup [OPTIONS <myloader-options-label> - difficult to know as I have not yet used it so I don't know how it works. And having difficulties to do so due to unclear documentation.

@anttilaiti anttilaiti added the bug Something isn't working label May 27, 2024
@davidducos davidducos added the documentation Improvements or additions to documentation label May 27, 2024
@davidducos
Copy link
Member

Hi @anttilaiti, I think that you are seeing in that way because Github is automatically selecting the Preview mode, but if you change to Code, you will see the same than raw. Take into account that the .rst files are use to build the documentation in html.

@davidducos davidducos transferred this issue from mydumper/mydumper Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants