Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Author field incorrectly populating #3

Open
sdodsley opened this issue Feb 2, 2020 · 4 comments · Fixed by #4
Open

Author field incorrectly populating #3

sdodsley opened this issue Feb 2, 2020 · 4 comments · Fixed by #4

Comments

@sdodsley
Copy link

sdodsley commented Feb 2, 2020

If, in my module, the author field is similar to:

author: The module developer

The RST file produced renders each letter as a separate bullet point, eg:

Authors
~~~~~
- T
- h
- e
-
- m
- o
- d
- u
- l
- e
-
- d
- e
- v
- e
- l
- o
- p
- e
- r
@tadeboro
Copy link
Contributor

tadeboro commented Feb 2, 2020

The latest version on PyPI (https://pypi.org/project/ansible-doc-extractor/0.1.2/) should have this problem resolved. If not, can you please reopen the issue? Thanks.

@sdodsley
Copy link
Author

sdodsley commented Feb 3, 2020

Thanks for that fix. The Authors section is resolved, but I am still seeing the same thing in a few other places, specifically in the description field of an option for a module.
This can either be a string or a list.
For example:

description:
 - something here

works fine, but

description: something else

doesn't.

@tadeboro tadeboro reopened this Feb 3, 2020
@tadeboro
Copy link
Contributor

tadeboro commented Feb 3, 2020

This one will be a bit trickier to solve since options can be arbitrarily nested. I will try to cook something up in the following days.

@sdodsley
Copy link
Author

sdodsley commented Feb 3, 2020

I can work around this by making my modules use the working method, so no time constraints here.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants