On 12 December 2017 at 00:50,  <[email protected]> wrote:
> This is an automated email from the ASF dual-hosted git repository.
>
> curcuru pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/whimsy.git
>
>
> The following commit(s) were added to refs/heads/master by this push:
>      new b3499e0  Refactor and add some mbox features
> b3499e0 is described below
>
> commit b3499e09b7519dec3d5bf9c99dbd9d48c7853693
> Author: Shane Curcuru <[email protected]>
> AuthorDate: Mon Dec 11 19:52:03 2017 -0500
>
>     Refactor and add some mbox features
> ---
>  tools/ponyapi.rb  |  88 ++++++++++++++++++++++++++++++++++++++++++++
>  tools/ponypoop.rb | 108 
> +++++++++++-------------------------------------------
>  2 files changed, 109 insertions(+), 87 deletions(-)
>
> diff --git a/tools/ponyapi.rb b/tools/ponyapi.rb
> new file mode 100644
> index 0000000..c8be57d
> --- /dev/null
> +++ b/tools/ponyapi.rb
> @@ -0,0 +1,88 @@
> +#!/usr/bin/env ruby
> +<<~HEREDOC
> +Pony down: utilities for downloading Ponymail APIs (stats.lua or mbox.lua)
> +See also: https://ponymail.incubator.apache.org/docs/api
> +HEREDOC

Any particular reason why the doc header uses HEREDOC rather than
comment markers?

I find it a bit harder to read, and my IDE Ruby plugin cannot parse
the <<~ prefix.
Would it be OK to use #comment instead?

Reply via email to