Skip to content

Conversation

Chuan1937
Copy link

@Chuan1937 Chuan1937 commented Oct 11, 2025

Fix typo in [ |SYN_OPT-V| ] and correct -T option syntax

Description of proposed changes
This pull request fixes two minor documentation issues:

  1. Corrected a typo in the option reference [ |SYN_OPT-V| ], ensuring consistent formatting with other option references.

  2. Fixed the -T option syntax in the documentation, changing

    **-Tc**\ |\ **g**\ |\ **o**\ |\ **s**
    

    to

    **-T**\ **c**\|\ **g**\|\ **o**\|\ **s**
    

Why this change was made
The original documentation contained inconsistent formatting and incorrect escape usage that could cause confusion when reading or generating documentation.

Fixes #


Reminders

  • Make sure that your code follows our style.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Describe changes to function behavior and arguments in a comment below the function declaration.
  • If adding new functionality, add a detailed description to the documentation and/or an example.

Fix typo: [ |SYN_OPT-V| ]
@welcome
Copy link

welcome bot commented Oct 11, 2025

💖 Thanks for opening this pull request! 💖

Please make sure you read our Contributing Guide and abide by our Code of Conduct.

A few things to keep in mind:

  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the comments below for your functions describing the it, all arguments, and return types before writing the code. This will help you think about your code design and results in better code.
  • We are grateful that you put in the effort to do this! 🎉

 fix the -T syntax
@Chuan1937 Chuan1937 changed the title Fix typo in mlconverter.rst Fix typo in [ |SYN_OPT-V| ] and correct -T option syntax Oct 11, 2025
@joa-quim
Copy link
Member

Hi,
Can you please restrict the fix to the first commit? There is nothing wrong that needs to be fixed on the second case.

@seisman
Copy link
Member

seisman commented Oct 12, 2025

The -T syntax is wrong. It can be verified in https://rsted.info.ucl.ac.be/

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.

3 participants