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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix documentation example error #2

Merged
merged 1 commit into from
Feb 22, 2019

Conversation

inishchith
Copy link
Contributor

  • Fix python interface example of CoCom backend under documentation. Reference
  • Fix parameter definition. Reference

@jgbarah @valeriocos Please review and let me know if any changes required 馃槃

@inishchith inishchith changed the title Fix typo Fix documentation example error Feb 22, 2019
Copy link
Contributor

@jgbarah jgbarah left a comment

Choose a reason for hiding this comment

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

Minor detail, but looks good to me, improves consistency. Thanks!

@inishchith
Copy link
Contributor Author

@jgbarah Yeah, i was trying to run CoCom & CoLic backends so found these. thought these would help others who might refer Readme.md for starters 馃槃

@valeriocos valeriocos self-requested a review February 22, 2019 10:55
Copy link
Member

@valeriocos valeriocos left a comment

Choose a reason for hiding this comment

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

Thank you @inishchith for the PR. Overall LGTM, I would ask you to:

  • if possible squash the commits in one.
  • prepend each commit message with a label, for instance [doc] Fix documentation for Cocom backend.
  • include some lines in the commit message to describe its content. For instance, you could reuse the PR description (without adding the references).

@inishchith inishchith changed the title Fix documentation example error [doc] Fix documentation example error Feb 22, 2019
@inishchith
Copy link
Contributor Author

@valeriocos Thanks for the review. I've reset and made them into a single commit and updated the commit message as required. Let me know if any changes required 馃槄

@valeriocos
Copy link
Member

Thank you for the quick reply @inishchith , just a minor thing about the commit message.
The one below is the current one:

* [doc] Fix documentation for Cocom backend

    Fix python interface example of `CoCom` backend under documentation.
* [doc] Fix parameter definition.

please change it to:

[doc] Fix documentation for Cocom backend

Fix python interface example of `CoCom` backend under documentation and parameter definition in `CoCom` class

Fix python interface example of `CoCom` backend under documentation and parameter definition in `CoCom` class
@inishchith
Copy link
Contributor Author

@valeriocos Sorry for that. I've updated the commit message.

@valeriocos valeriocos merged commit e75194a into chaoss:master Feb 22, 2019
@valeriocos
Copy link
Member

No worries @inishchith . Thank you a lot for your PR (just merged :) )

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.

None yet

3 participants