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 return value docs and samples #250

Merged
merged 1 commit into from
Nov 22, 2020
Merged

Improved return value docs and samples #250

merged 1 commit into from
Nov 22, 2020

Conversation

andy-maier
Copy link
Member

See commit message.

@GitCop
Copy link

GitCop commented Nov 20, 2020

There were the following issues with your Pull Request

  • Commit: e0a0ef9
  • Your commit message body contains a line that is longer than 80 characters

Guidelines are available at https://github.com/zhmcclient/zhmc-ansible-modules/blob/master/CONTRIBUTING.rst

This message was auto-generated by https://gitcop.com

@andy-maier andy-maier self-assigned this Nov 20, 2020
@andy-maier andy-maier added this to the 1.0.0 milestone Nov 20, 2020
@coveralls
Copy link

coveralls commented Nov 20, 2020 •
edited
Loading

Coverage Status

Coverage remained the same at 20.457% when pulling f492838 on andy/sample-returns into 67ea98b on master.

@andy-maier andy-maier force-pushed the andy/sample-returns branch 2 times, most recently from f5bd5a8 to e486a0f Compare November 22, 2020 17:34
@zhmcclient zhmcclient deleted a comment from andy-maier Nov 22, 2020
@zhmcclient zhmcclient deleted a comment from andy-maier Nov 22, 2020
@zhmcclient zhmcclient deleted a comment from andy-maier Nov 22, 2020
sabyadi
sabyadi suggested changes Nov 22, 2020
View reviewed changes
Copy link
Contributor

@sabyadi sabyadi left a comment

Choose a reason for hiding this comment

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

Please have a look at my comments.

@andy-maier
Improved return value docs and samples
f492838 
Details:

* Added 'changed' and 'msg' fields to the documented RETURNS string.

* Made sure that the RETURNS doc string of all modules is in sync with the
  actual output, shows all artificial properties, shows all child resources,
  and for all resources shows a placeholder for remaining properties along
  with a link to the specific data model for that resource in the HMC API
  book.

* Added samples in most cases.

* This fixed errors in the described structure of return data for the
  following modules and result elements:
  - zhmc_adapter: 'ports' was described as a dict but is a list. Fixed
    description.
  - zhmc_cpc: 'adapters', 'partitions' and 'storage-groups' were described as
    dicts but are lists. Fixed description.
  - zhmc_storage_group: 'cpc-name' and 'cpc' were described but not
    implemented. Removed from description.
  - zhmc_user: 'user-pattern', 'password-rule', and 'ldap-server-definition'
    were missing from description. Added to description.
    Also, 'default-group-name' was described but is not implemented yet.
    Removed from description.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
@andy-maier
Copy link
Member Author

andy-maier commented Nov 22, 2020 •
edited
Loading

I rebased, resolved the merge conflicts, and resolved those of Adilet's comments that are marked as resolved.

For the remaining two comments I think we do not need to change anything. Let me know whether you agree @sabyadi

@sabyadi sabyadi merged commit 1d5056e into master Nov 22, 2020
@sabyadi sabyadi deleted the andy/sample-returns branch November 22, 2020 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sabyadi sabyadi sabyadi requested 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
4 participants
@andy-maier @GitCop @coveralls @sabyadi