Skip to content

MQE-1376: [SPIKE] Investigate Self-Documentation for MFTF #324

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

Merged
merged 13 commits into from
Apr 22, 2019

Conversation

aljcalandra
Copy link
Contributor

Adding a command generate:docs to allow for local generation of documentation for action groups

Description

Adding unit tests, documentation and a command to MFTF to enable self-documentation.

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/verification tests (if applicable)
  • All automated tests passed successfully (all builds on Travis CI are green)
  • Changes to Framework doesn't have backward incompatible changes for tests or have related Pull Request with fixes to tests

- Added some mild documentation for action groups
- Added more information
- Made deprecation warning specific to generate:docs
- Added unit tests
- Updated functions to facilitate unit testing
@aljcalandra aljcalandra requested a review from KevinBKozan March 29, 2019 18:51
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.9%) to 55.865% when pulling 995aa18 on MQE-1376 into 44aecc6 on develop.

@coveralls
Copy link

coveralls commented Mar 29, 2019

Coverage Status

Coverage decreased (-2.4%) to 54.621% when pulling a766d44 on MQE-1376 into 8af7dc4 on develop.

Copy link
Contributor

@KevinBKozan KevinBKozan left a comment

Choose a reason for hiding this comment

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

Overall looks good, just some minor changes needed + some questions for you

- Correcting Build failures, correcting object instantiation
- Using constants from respective classes
Copy link
Contributor

@KevinBKozan KevinBKozan left a comment

Choose a reason for hiding this comment

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

QA complete, one super small change requested.

- Added output directory to end of command
KevinBKozan
KevinBKozan previously approved these changes Apr 18, 2019
@KevinBKozan KevinBKozan merged commit a86f010 into develop Apr 22, 2019
@KevinBKozan KevinBKozan deleted the MQE-1376 branch July 26, 2019 19:28
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.

3 participants