search

zmb3 / godoc

Deprecated - use https://atom.io/packages/go-plus instead
MIT License
3 stars 1 forks source link

Documentation paragraph format is incorrectly parsed at times #18

Closed VinayGupta23 closed 8 years ago

VinayGupta23 commented 8 years ago

I have just installed the godoc tool for Atom, and I believe there are certain issues with how the documentation is being displayed.

The recommended way to document code is described here, and it is exactly what I'm doing. However I noticed that somehow the parser seems to append new line at random locations, which makes the documentation look very broken and poorly justified.

This is an example from a built-in library by the Go creators, which I believe displayed incorrectly: library doc example

And another from a file I've written: ex2

This does not happen always, and these are some examples where they do. Please check up on the same.

P.S. I really look forward to using this tool extensively, so I would appreciate any feedback and correction. Thanks!

zmb3 commented 8 years ago

Thanks for the report. You aren't doing anything wrong, the tool is just wrapping lines at 80 chars.

I'm currently working on some UI updates that will fix this and improve the overall feel of the package. You can expect a fix for this in the next few days :) On Jun 17, 2016 12:15 PM, "Vinay Gupta" notifications@github.com wrote:

I have just installed the godoc tool for Atom, and I believe there are certain issues with how the documentation is being displayed.

The recommended way to document code is described here https://blog.golang.org/godoc-documenting-go-code, and it is exactly what I'm doing. However I noticed that somehow the parser seems to append new line at random locations, which makes the documentation look very broken and poorly justified.

This is an example from a built-in library by the Go creators, which I believe displayed incorrectly: [image: library doc example] https://cloud.githubusercontent.com/assets/8874825/16160287/f1a1b470-34e4-11e6-9dfa-aa4485fefe19.PNG

And another from a file I've written: [image: ex2] https://cloud.githubusercontent.com/assets/8874825/16160318/0d8b17b2-34e5-11e6-8092-c62cd0edf517.PNG

This does not happen always, and these are some examples where they do. Please check up on the same.

P.S. I really look forward to using this tool extensively, so I would appreciate any feedback and correction. Thanks!

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/zmb3/godoc/issues/18, or mute the thread https://github.com/notifications/unsubscribe/AHLav84rHjTvIB2VKDN6Igq676iG3Xlpks5qMuRBgaJpZM4I4mwn .

VinayGupta23 commented 8 years ago

That's great, I'll keep a look out :)

zmb3 commented 8 years ago

Fixed in release 0.3.0 (461488a4b6075aa19541a7614898515b344b0c43)