Skip to content

adjust supported selectors doc section for block formatting#16

Merged
ericchiang merged 1 commit intoericchiang:mainfrom
bmizerany:formattingfix
Aug 17, 2024
Merged

adjust supported selectors doc section for block formatting#16
ericchiang merged 1 commit intoericchiang:mainfrom
bmizerany:formattingfix

Conversation

@bmizerany
Copy link
Copy Markdown
Contributor

This commit changes the supported selectors doc section to render in a code block on pkgsite. Previously, the section was treated as a single bullet point and mushed together.

One downside of the Universal Selector is that is considered a bullet in GoDoc, which caused the formatting issue. This change also moves the mentioning of it the introduction of the block to avoid the issue.

This commit changes the supported selectors doc section to render in a
code block on pkgsite. Previously, the section was treated as a single
bullet point and mushed together.

One downside of the Universal Selector is that is considered a bullet in
GoDoc, which caused the formatting issue. This change also moves the
mentioning of it the introduction of the block to avoid the issue.
@bmizerany
Copy link
Copy Markdown
Contributor Author

Thank you very much for this wonderful package! I've been going to the docs for selector reference and kept finding it a little hard to read. Currently it looks like:

CleanShot 2024-08-15 at 10 53 36@2x

This change looks like:

CleanShot 2024-08-15 at 10 53 47@2x

The asterisk problem was a little hairy because gofmt keeps changing it to a - // Universal Selector to standardize it on - for a list over *. I could not find a way to convince godoc it was not in fact a list, so moving it out of the list was the only way I could come up with to fix the issue. I'm happy to change it to use some other way if anyone knows how to fix the issue.

@ericchiang
Copy link
Copy Markdown
Owner

Thanks for the fix!

@ericchiang ericchiang merged commit 48ff195 into ericchiang:main Aug 17, 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

Successfully merging this pull request may close these issues.

2 participants