search

andresbott / ansible-autodoc

ansible-autodoc generates documentation from annotated Ansible Playbooks and Roles.
GNU Lesser General Public License v3.0
46 stars 26 forks source link

Uppercase/Lowercase issue in meta author #3

Open tsvsj opened 4 years ago

tsvsj commented 4 years ago

Hi @AndresBott,

thanks for this awesome tool! I was looking for something like PHPDoc to generate my README.md and came along to this project. I'm impressed!

I've seen that there is a cosmetic issue in @meta author and @meta email:

# @meta author: Kevin James
# @meta email: kevin.james@example.com

will result in

This role:  was created by: Kevin james <LINEBREAK>
Kevin.james@example.com

So the last name of the author is fully in lowercase, while the email address is capitalized. Addtionally it would be great to have author and email in a single line and the email in angle brackets ('<>').

Thanks!

alexis-renard commented 4 years ago

Totally agree. For now it doesn't look very "finished"... this would be an awesome feature !