From 8d19424e4b97c71c839c86811a9efe2a4a4bec1d Mon Sep 17 00:00:00 2001 From: Andrew Haines Date: Wed, 10 Nov 2021 11:09:21 +0000 Subject: [PATCH 1/2] Use commonmarker to render markdown documentation --- .yardopts | 1 + Gemfile | 3 ++- Gemfile.lock | 13 +++++++++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.yardopts b/.yardopts index 0ad8459..0fa4a8d 100644 --- a/.yardopts +++ b/.yardopts @@ -1,4 +1,5 @@ --markup markdown +--markup-provider commonmarker --no-private - *.md diff --git a/Gemfile b/Gemfile index 5f9b4ff..ecc03e4 100644 --- a/Gemfile +++ b/Gemfile @@ -5,6 +5,7 @@ gemspec gem "aws-sdk-ec2" gem "bundler" +gem "commonmarker" gem "minitest" gem "minitest-reporters" gem "pry" @@ -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" } diff --git a/Gemfile.lock b/Gemfile.lock index 00f3177..703fe95 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -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: @@ -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) @@ -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 @@ -90,6 +98,7 @@ DEPENDENCIES activerecord aws-sdk-ec2 bundler + commonmarker minitest minitest-reporters pg @@ -100,7 +109,7 @@ DEPENDENCIES rubocop-minitest rubocop-rake timecop - yard + yard! BUNDLED WITH 2.2.21 From 7cff82af522a063aa67560315452cb3681021c18 Mon Sep 17 00:00:00 2001 From: Andrew Haines Date: Wed, 10 Nov 2021 11:21:28 +0000 Subject: [PATCH 2/2] Make code snippets in README valid Ruby to fix syntax highlighting --- CHANGELOG.md | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 458a710..48f18a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index c26ed7a..554ebeb 100644 --- a/README.md +++ b/README.md @@ -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 ```