Fix YARD docs markdown rendering (#2310)

* Fix YARD doc markdown rendering * Fix Rubocop violation * Fix contain_exactly test --------- Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>
ruby-grape · Mar 20, 2023 · d6b26af · d6b26af
1 parent cdb8316
commit d6b26af
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -35,6 +35,7 @@ dist
 Gemfile.lock
 gemfiles/*.lock
 tmp
+.yardoc
 
 ## Rubinius
 .rbx

diff --git a/.yardopts b/.yardopts
@@ -1 +1,2 @@
 --asset grape.png
+--markup markdown
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 * [#2303](https://github.com/ruby-grape/grape/pull/2302): Rack >= 1.3.0 - [@ericproulx](https://github.com/ericproulx).
 * [#2301](https://github.com/ruby-grape/grape/pull/2301): Revisit GH workflows - [@ericproulx](https://github.com/ericproulx).
 * [#2311](https://github.com/ruby-grape/grape/pull/2311): Fix tests by pinning rack-test to < 2.1 - [@duffn](https://github.com/duffn).
+* [#2310](https://github.com/ruby-grape/grape/pull/2310): Fix YARD docs markdown rendering - [@duffn](https://github.com/duffn).
 * Your contribution here.
 
 #### Fixes

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -58,6 +58,8 @@ Make sure that `bundle exec rake` completes without errors.
 
 Document any external behavior in the [README](README.md).
 
+You should also document code as necessary, using current code as examples. This project uses [YARD](https://yardoc.org/). You can run and preview the docs locally by [installing `yard`](https://yardoc.org/), running `yard server --reload` and view the docs at http://localhost:8808.
+
 #### Update Changelog
 
 Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.