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.

Sign up for GitHub

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

Jump to bottom

Improved module documentation #132

Merged
merged 1 commit into from Oct 1, 2020
Merged

Improved module documentation #132

merged 1 commit into from Oct 1, 2020

Conversation

andy-maier
Copy link
Member

@andy-maier andy-maier commented May 5, 2020 •
edited

For details, see the commit message.

@andy-maier andy-maier self-assigned this May 5, 2020
@andy-maier andy-maier added this to the 0.9.0 milestone May 5, 2020
@coveralls
Copy link

coveralls commented May 5, 2020 •
edited

Coverage Status

Coverage remained the same at 20.026% when pulling f4221c2 on andy/improve-docs into 0672385 on master.

@andy-maier
Copy link
Member Author

I plan to update this one once PR #139 is merged.

@andy-maier andy-maier force-pushed the andy/improve-docs branch 4 times, most recently from 966fbf0 to f2133b0 Compare September 17, 2020 11:45
@andy-maier
Copy link
Member Author

Has been rebased on top of PR #139.

@andy-maier
Copy link
Member Author

Has been rebased on master, after merging PR #139.
Ready for review.

@andy-maier
Improved module documentation
f4221c2 
Details:

* Removed Ansible and its minimum version 2.2 from the prerequisites.

* Added explicit type definitions to module input parameters, because the
  implied types are not shown in the generated docs.

* Changed description of defaults to null where they had text such
  as 'the real HMC' or 'no properties changed' and made sure the
  description of the parameter is clear about what that means.

* Simplified title of the modules and made sure they are understandable
  by non Z persons.

* Changed cross references to other modules fron note to seealso.

Signed-off-by: Andreas Maier <maiera@de.ibm.com>
vkathir82
vkathir82 approved these changes Sep 23, 2020
View reviewed changes
Copy link
Contributor

@vkathir82 vkathir82 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Andy, Changes related to Z system and other operations are looking good to me

@andy-maier andy-maier merged commit 5ff8908 into master Oct 1, 2020
@andy-maier andy-maier deleted the andy/improve-docs branch October 1, 2020 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vkathir82 vkathir82 vkathir82 approved these changes

Assignees

@andy-maier andy-maier

Labels
None yet
Projects
None yet
Milestone
0.9.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@andy-maier @coveralls @vkathir82