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.

Sign up for GitHub

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

Use commonmarker to render markdown documentation #274

Merged
merged 2 commits into from
Nov 10, 2021
Merged

Use commonmarker to render markdown documentation #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d19424
Use commonmarker to render markdown documentation
haines Nov 10, 2021
7cff82a
Make code snippets in README valid Ruby to fix syntax highlighting
haines Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .yardopts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
--markup markdown
--markup-provider commonmarker
--no-private
-
*.md
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

No notable changes.
### Fixed
* Make code snippets in README valid Ruby to fix syntax highlighting ([#274](https://github.com/haines/pg-aws_rds_iam/pull/274))

## [0.3.0] - 2021-11-10

Expand Down
3 changes: 2 additions & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ gemspec

gem "aws-sdk-ec2"
gem "bundler"
gem "commonmarker"
gem "minitest"
gem "minitest-reporters"
gem "pry"
Expand All @@ -13,7 +14,7 @@ gem "rubocop"
gem "rubocop-minitest"
gem "rubocop-rake"
gem "timecop"
gem "yard"
gem "yard", github: "lsegal/yard"

["activerecord", "pg"].each do |gem_name|
gem gem_name, *ENV["#{gem_name.upcase}_VERSION"]&.yield_self { |gem_version| "~> #{gem_version}.0" }
Expand Down
13 changes: 11 additions & 2 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
GIT
remote: https://github.com/lsegal/yard.git
revision: 9865620413d3519b561d87479e44f1b4fe782904
specs:
yard (0.9.26)
webrick (~> 1.7.0)

PATH
remote: .
specs:
Expand Down Expand Up @@ -38,6 +45,7 @@ GEM
aws-eventstream (~> 1, >= 1.0.2)
builder (3.2.4)
coderay (1.1.3)
commonmarker (0.23.2)
concurrent-ruby (1.1.8)
i18n (1.8.9)
concurrent-ruby (~> 1.0)
Expand Down Expand Up @@ -80,7 +88,7 @@ GEM
tzinfo (2.0.4)
concurrent-ruby (~> 1.0)
unicode-display_width (2.1.0)
yard (0.9.26)
webrick (1.7.0)
zeitwerk (2.4.2)

PLATFORMS
Expand All @@ -90,6 +98,7 @@ DEPENDENCIES
activerecord
aws-sdk-ec2
bundler
commonmarker
minitest
minitest-reporters
pg
Expand All @@ -100,7 +109,7 @@ DEPENDENCIES
rubocop-minitest
rubocop-rake
timecop
yard
yard!

BUNDLED WITH
2.2.21
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ If the default authentication token generator doesn't meet your needs, you can r

```ruby
PG::AWS_RDS_IAM.auth_token_generators.add :custom do
PG::AWS_RDS_IAM::AuthTokenGenerator.new(credentials: ..., region: ...)
PG::AWS_RDS_IAM::AuthTokenGenerator.new(credentials: "...", region: "...")
end
```

Expand Down