Update line spacing about ga4gh-schemas HOT 6 CLOSED

Specifically, any multi-line comment should not be indented to the level of the code that the comment applies to. Given the following Avro IDL

@namespace("com.example")
/**
This is a comment for the whole protocol
*/
protocol Example {
/**
The comment applies to the `NoSpaces` record, but is not indented to the 
level of the record specification.
*/
  record NoSpaces {
    /** This is a single line comment that is indented for readibility,
    and is not effected by indentation. */
    string single_line_comment_property;
/**
This multi-line comment on `mult_line_property` that would be effected by indentation.
This is another paragraph
    
    This is an indented block and should be shown as 
    such.
Here is a code block that apparently does not work for avrodoc. E.g. no [GFM](https://help.github.com/articles/github-flavored-markdown) support.
```ruby
# this is a Ruby code block
def method(arg1, arg2=nil)
  puts "hello world!"
end
```
*/
    string multi_line_property;
  }
}
```

And refer to here for output:

http://angelfiles.s3.amazonaws.com/ga4gh/doc/test2.html#/schema/com.example.NoSpaces

from ga4gh-schemas.

@delagoya - I think the preference from the other issue was something more like this:

@namespace("com.example")
/**
comment
*/
protocol Example {
record x {
../**
..paragraph #1

..paragraph #2
..*/
..string y;
}
}

(in other words, the 2-space indent for fields/comments gets us at least some semblance of everything lining up without causing issues)

from ga4gh-schemas.

Is this issue able to be closed?

from ga4gh-schemas.

I think we need a PR to actually update the code indents.

from ga4gh-schemas.

@delagoya @cassiedoll is correct, IIRC; I think we're still waiting on a PR. I can take a shot at that today.

from ga4gh-schemas.

Thanks Frank!

from ga4gh-schemas.