fwal / danger-jazzy Goto Github PK

The default handling will just show "Undocumented symbol" without naming it or referencing to a file or line.

I noticed today that Github released a beta feature for quickly suggesting changes in a PR.

Basically all you have to do is comment a specific change on a line like so (without backslashes):

\```suggestion
someCodeChange()
\```

and it will place a button to quickly apply that suggested change in the Conversation view for a PR. Example:

I think it would be a nice addition to have an automatic suggestion which simply adds :nodoc: to the end of the method or variable definition. I realize that the feature is still in beta though.

Hi, good plugin, thanks for creating it 👍
I think it deserves to be visible for all of the danger.systems website visitors, do you want to publish it there?

Here is a readme how to do it.

If you link to an image or other resource in the documentation, the plugin should check that it exists.