Skip to content
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

Document return values #901

Merged
merged 5 commits into from
Jul 27, 2020
Merged

Conversation

mdellweg
Copy link
Member

Supersedes #654

@mdellweg mdellweg force-pushed the document_return_values branch from ba7979f to 387c724 Compare July 25, 2020 13:21
@evgeni
Copy link
Member

evgeni commented Jul 26, 2020

Thanks for picking this up again!

Two questions:

  1. can we use doc fragments here (I guess no and we should file an RFE against Ansible)
  2. Can we somehow automate the generation? Or did you gather all the data manually?

@mdellweg
Copy link
Member Author

I didn'd gather all the data. I just looked at the ones suspicious enough. So it might be incomplete. Also i refrained from detailing it in every PR. Trying to do so put the first PR on hold... So i'd rather see this as an improvement, and leave more details to future PRs. At least it's not lying about the return value anymore, maybe just not telling the whole truth.
Can we generate it? Maybe we can debug the structure of the return values to a file, but we'd need to invent all the descriptions anyway.

@evgeni
Copy link
Member

evgeni commented Jul 27, 2020

No, fragments in return don't work: ansible/ansible#70910

And yeah, this is totally an improvement!

@evgeni evgeni merged commit 05a384b into theforeman:develop Jul 27, 2020
@mdellweg mdellweg deleted the document_return_values branch July 27, 2020 08:06
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.

2 participants