Skip to content
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

Suggest Removing Installation Instructions for godoc in Favor of doc Instructions #691

Open
MeirSedlis opened this issue Jul 20, 2023 · 5 comments

Comments

@MeirSedlis
Copy link

Hello World contains instructions for installing godocs but the doc (reference) command works very similarly and is a faster and more lightweight command which may be better suited for learners.

I would be happy to create a PR for this if you agree that doc is a more appropriate command for this section.

@quii
Copy link
Owner

quii commented Jul 21, 2023

Go for it!

@Battlesheepu
Copy link
Contributor

Battlesheepu commented Feb 28, 2024

Since this was never updated and godoc is now deprecated (as I also mentioned in #653 )

The package is now replaced by pkgsite. Should we go for that replacement instead of doc? Reason being pkgsite having very similar functionality to the deprecated godoc (namely, serving docs locally on a http server).

@quii
Copy link
Owner

quii commented Feb 29, 2024

Please do!

@Battlesheepu
Copy link
Contributor

Battlesheepu commented Mar 4, 2024

@quii

Sorry for the vagueness in the now-deleted previous comment, which I've noticed only after re-reading it. Let me try again.

It seems that pkgsite doesn't play nice with modules without a '.' in their name, as these are treated as std libraries, which, for me and for the related issue's creator, simply breaks the generated docs. I've found out about this only after generating the docs for myself - which I treat as pkgsite needing a bit more work, since we're being hit with error 424 instead of an explanation in the docs.

I'd like to retract my suggestion of replacing godoc with pkgsite - instead, I propose simply adding a note about godoc being deprecated and replaced by pkgsite, so the situation is clear for the reader. What do you think?

@quii quii closed this as completed Jun 21, 2024
@quii quii reopened this Jun 21, 2024
@zacharysyoung
Copy link

@Battlesheepu, following your link to the issue about modules without a dot (.), I've reached some different conclusions.

From, golang/go#51368, I found this issue, golang/go#32819, and the discussion there very clearly concludes that modules without a dot are (almost entirely) reserved, and that the documentation needed to be updated; and it was: golang/website@3e18747.

Both of those issues have been closed.

From all that, I conclude that:

  • pkgsite will not some day play nice in the way you hope
  • learn-go-with-tests might take an opportunity to explain to readers (fresh and seasoned alike) that creating module names without dots (for whatever reason, including brevity for the sake of teaching) comes with risks

zacharysyoung added a commit to zacharysyoung/learn-go-with-tests that referenced this issue Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants