You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have been using protokit as part of our process of auto-generating API reference documentation from proto files. We are experiencing some issues caused by the scrub function in comments.go
The function obviously trims white spaces but this causes grammar issues in the resulting comments.
Rather than having a single line string, proto comments are often structured in the following way to improve readability in the actual proto:
// The definition of a book resource in the// context of the university library.messageBook{}
Due to the scrub function, this will cause the sentence to include thecontext rather than having a space between the words.
This is our primary use case for using comments so just want to check whether scrub is actually used for cases I am not envisioning and whether I can submit a PR to remove it.
The text was updated successfully, but these errors were encountered:
Thanks for the great repo @pseudomuto.
We have been using protokit as part of our process of auto-generating API reference documentation from proto files. We are experiencing some issues caused by the
scrub
function incomments.go
protokit/comments.go
Line 91 in dc6fd1c
The function obviously trims white spaces but this causes grammar issues in the resulting comments.
Rather than having a single line string, proto comments are often structured in the following way to improve readability in the actual proto:
Due to the
scrub
function, this will cause the sentence to include thecontext rather than having a space between the words.This is our primary use case for using comments so just want to check whether
scrub
is actually used for cases I am not envisioning and whether I can submit a PR to remove it.The text was updated successfully, but these errors were encountered: