Sha256: fbbc0bff2483fe2700541be930289b3270026b90ad81c38443c20c9e8144347c
Contents?: true
Size: 1.18 KB
Versions: 1
Compression:
Stored size: 1.18 KB
Contents
### jazzy This is a danger plugin to check for undocumented symbols via Jazzy. <blockquote>Fail on undocumented symbols in modified files. <pre> jazzy.check</pre> </blockquote> <blockquote>Fail on undocumented symbols in all files. <pre> jazzy.check fail: :all</pre> </blockquote> <blockquote>Warn about undocumented symbols in modified files. <pre> jazzy.check warn: :modified</pre> </blockquote> <blockquote>Write a custom message for undocumented symbols in modified files. <pre> jazzy.undocumented.each do |item| message "You forgot to document this", file:item.file, line:item.line end</pre> </blockquote> <blockquote>Write a custom message for undocumented symbols in all files. <pre> jazzy.undocumented(:all).each do |item| message "You forgot to document this", file:item.file, line:item.line end</pre> </blockquote> #### Attributes `path` - Path to the docs folder, defaults to 'docs/'. #### Methods `check` - Checks files for modified symbols. Takes a hash with the following keys: * `fail` * `warn` Available scopes: * `modified` * `all` `undocumented` - Returns a list of undocumented symbols in the current diff. Available scopes: * `modified` * `all`
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
danger-jazzy-1.0.0 | README.md |