will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add documentation

Browse Source
This commit is contained in:
Petr Korolev 2015-03-27 17:15:08 +02:00
parent ae0d1d16de
commit d361baaec5
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/github_changelog_generator/generator.rb
View File

@ -4,6 +4,13 @@ module GitHubChangelogGenerator
@options = options @options = options
end end
# Parse issue and generate single line formatted issue line.
#
# Example output:
# - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) ([skywinder](https://github.com/skywinder))
#
# @param [Hash] issue Fetched issue from GitHub
# @return [String] Markdown-formatted single issue
def get_string_for_issue(issue) def get_string_for_issue(issue)
encapsulated_title = encapsulate_string issue[:title] encapsulated_title = encapsulate_string issue[:title]