-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build.Doc() doesn't play well with multi-line doc strings. #230
Comments
I hasten to add: yes, I know that |
Hmmm, yes agree A and B are not ideal. I could change Not sure about auto-wrapping, it's not always what you'd want. Maybe a different function like |
I'm not that enthusiastic about auto-wrapping, agree that's really on the coder to auto wrap if they want. Note that TEXT("add", NOSPLIT, "func(x, y uint64) uint64")
Doc("add adds x and y.")
Comment("This belongs on\n multiple lines") In asm output:
|
Attempt A:
For example:
Produces invalid syntax:
Attempt B:
Using
Doc
multiple times...... doesn't work as expected:
Attempt C:
Just writing a really long docstring...
...doesn't result in a sensibly wrapped output:
Suggestion:
Cases A and B are arguably bugs. Case C would be nice to fix, but is probably not needed if A and B are fixed.
The text was updated successfully, but these errors were encountered: