ansible-collections / ansible.netcommon

Ansible Network Collection for Common Code
GNU General Public License v3.0
145 stars 104 forks source link

Typo in Documentation for telnet module parameters #633

Open lucabodd opened 6 months ago

lucabodd commented 6 months ago

Hello,

I've noticed a small typo in the documentation of the Telnet module. In the table of parameters here and here and possibly elsewhere in the documentation, the parameter is incorrectly named "crlf" while in the source code it is correctly identified as "clrf".

imagen imagen (1)

This can lead to confusion for users trying to implement or troubleshoot configurations involving carriage return and line feed settings.

Steps to Reproduce:

  1. Go to the Telnet module documentation page doc1 and doc3.
  2. Observe the parameter listing in the TOC and compare it with the actual code or detailed parameter description in the module.

Expected Result: The parameter should be consistently named throughout all documentation to match the source code.

Thank you for your attention to this matter!

Best regards, b0d