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

Feature documentation #73

Merged
merged 13 commits into from
May 11, 2017
Merged

Conversation

jrbeilke
Copy link
Collaborator

This is a big one. Everything done here is backwards compatible code-wise, and all tests are passing in Travis CI - https://travis-ci.org/jrbeilke/zabbixapi/builds/223783663

  • Split up the main README and put all of the code examples into an /examples sub-directory with their own README and table of contents to better organize things.
  • Added YARD and documented as much of the code as possible. Can now view the code documentation locally using "yard server" or on rubydoc.info once this PR is merged.
  • Added RuboCop and updated the existing code to follow the majority of the Ruby Style guidelines.
  • Tweaked the Travis CI config to speed things up with the bundler cache and fix a few build issues (mostly jruby).

Copy link

@aladmit aladmit left a comment

Choose a reason for hiding this comment

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

This is the very good job! But why did you remove test_files,executables from zabbixapi.gempsec?

@jrbeilke
Copy link
Collaborator Author

gem test was deprecated/removed so test_files is no longer needed in the gemspec - rubygems/rubygems#730

The zabbixapi gem does not include a bin/ directory, or any executables, so I removed that from the gemspec as it is an optional attribute

@aladmit
Copy link

aladmit commented May 11, 2017

Okay, I got it. Thank you for PR! 👍

@aladmit aladmit merged commit d5be3da into express42:master May 11, 2017
@jrbeilke jrbeilke deleted the feature-documentation branch May 11, 2017 13:36
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

2 participants