From 7082e95fa2636d1d55c9fba3bf3574f912482679 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 4 Apr 2023 18:20:02 +1000 Subject: [PATCH] Fix word case: `yard` -> `YARD` https://yardoc.org/ --- README.md | 2 +- tasks/doc.rake | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c107f0b8..54e0165b9 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ See the [compile.md](doc/guides/compile.md) file for the detail. ## Building documentation -There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen and Graphviz) +There are two sets of documentation in mruby: the mruby API (generated by YARD) and C API (Doxygen and Graphviz) To build both of them, simply go diff --git a/tasks/doc.rake b/tasks/doc.rake index 50dc36180..11c0bd251 100644 --- a/tasks/doc.rake +++ b/tasks/doc.rake @@ -9,7 +9,7 @@ namespace :doc do begin sh "mrbdoc" rescue - puts "ERROR: To generate yard documentation, you should install yard-mruby gem." + puts "ERROR: To generate YARD documentation, you should install yard-mruby gem." puts " $ gem install yard-mruby yard-coderay" puts "https://yardoc.org/" puts "https://rubygems.org/gems/yard-mruby"