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

x/pkgsite: readme badges broken #42454

Closed
Delta456 opened this issue Nov 9, 2020 · 11 comments
Closed

x/pkgsite: readme badges broken #42454

Delta456 opened this issue Nov 9, 2020 · 11 comments

Comments

@Delta456
Copy link

@Delta456 Delta456 commented Nov 9, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/Delta456/box-cli-maker/v2

What is your user agent?

Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:82.0) Gecko/20100101 Firefox/82.0

Screenshot

image
image

What did you do?

Accessed the above pages and see they display everything properly.

What did you expect to see?

Badges are displayed properly.

What did you see instead?

README.md has broken badges.

@gopherbot gopherbot added the pkgsite label Nov 9, 2020
@gopherbot gopherbot added this to the Unreleased milestone Nov 9, 2020
@seankhliao
Copy link
Contributor

@seankhliao seankhliao commented Nov 9, 2020

you have a newline between your package documentation and the package declaration, go doc doesn't recognize it either

@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 9, 2020

There's one after the package declaration as for newline at the end of the file but I can see the first issue there.

@jba jba modified the milestones: Unreleased, pkgsite/unplanned Nov 9, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Nov 9, 2020

This might be related to #39297

@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 10, 2020

I think the badges are broken because I have div align them in the center.

@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 10, 2020

I have solved the displaying of doc.go issue but now the code isn't getting detected.

image

EDIT: do I have to tab my code lines?

EDIT 2: I have fixed it!

@Delta456 Delta456 changed the title x/pkgsite: doc.go and readme badges broken x/pkgsite: readme badges broken Nov 11, 2020
@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 11, 2020

I have updated the OP as I have resolved doc.go display issue, thanks to @seankhliao. Now just the badges are broken.

@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 16, 2020

Also shouldn't New function be placed under Functions sub heading? It is currently paced under Types.

image

@seankhliao
Copy link
Contributor

@seankhliao seankhliao commented Nov 16, 2020

It counts as a constructor for the Box type

@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 16, 2020

Ok

@jamalc jamalc self-assigned this Nov 18, 2020
@jamalc
Copy link
Member

@jamalc jamalc commented Nov 18, 2020

@Delta456 - this should now be fixed.

@jamalc jamalc closed this Nov 18, 2020
@Delta456
Copy link
Author

@Delta456 Delta456 commented Nov 19, 2020

@jamalc Thank You So Much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
6 participants