DrString

DrString copied to clipboard

Is there a way where I can integrate a styleguide like Google or Microsoft just like we can do in Vale? It would be super helpful since vale does not...

monica-m-ps

ACL Filtering

2

My team is starting to use DrString, but we're hitting a scenario that the library doesn't seem to support. We care that our publicly documented methods and variables are correct,...

rstone4-chwy

Add GitHub action formatter

1

Would be great to have a formatter that, when run in a GitHub action, formats the output in a way that can be understood by the runner and shows warnings...

kerrmarin-lvmh

Doesn't support CLI arguments file

1

Certain OSes limit the number of CLI arguments for any command. Usual solution is a file that contains all the command options.

dduan

dduan

A common-ish mistake for docstring author is to use the label of a parameter as opposed to the actual name. The error message in this scenario could be improved. Right...

dduan

`//` in continuation lines aren't reported as problems

1

``` /// blah blah blah //

dduan

No way to concatenate continuous lines

2

When an docstring entry spans multiple lines, there's no option to join them in addition to breaking over-the-column-limit lines up to newlines. Sometimes user may prefer automatic joining behavior. For...

dduan

`- note:` is not recognized?

1

This is a common-ish element. Should consider whether to check whitespace errors when it exists.

dduan

When parameter docs are out of order, the report is confusing

1

Right now you'll get a problem for a missing doc, and a problem for a redundant doc. There might be a good algorithm out there that could infer this better.

dduan