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

Use META_UNDERLINE_ON_HOVER in built-in class reference #89049

Merged

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Mar 1, 2024

Supersedes #64861

I am moved. Thank you #89024.

32880471e4e74d421b24e3cccdbe0616
c93327603394fd190aac30efb6f9cdb1
5589e90aa1bcce583717597349a9ca7f

You can see that those constants are harder to notice but it's nothing that can't be adjusted...

Please feel free to share opinions but this is the way to go now. It's consistent with the online docs, and it's just... almost objectively good, compared to #64861 ?

Note that this PR does not affect [url] tags at all for clarity.

@Mickeon Mickeon added this to the 4.x milestone Mar 1, 2024
@Mickeon Mickeon requested review from dalexeev and a team March 1, 2024 15:43
@dalexeev
Copy link
Member

dalexeev commented Mar 1, 2024

The effect looks nice to me. The link is already highlighted, but you can hover over it to make sure the text is clickable. We could add an editor setting meta_underline_behavior (always, on hover, never) but let's wait until someone actually requests it.

You can see that those constants are harder to notice but it's nothing that can't be adjusted...

I agree. Could you do it please?

@Mickeon
Copy link
Contributor Author

Mickeon commented Mar 1, 2024

I'm questioning how because I wouldn't want them to be the accent color as it has helped distinguish them from properties/methods more. I could also just make an underline exception for constants and flags? That sounds fine to me for now.

Last time I completely retouched the way built-in docs are stylized I explored the idea of hue-shifting the accent color for different "things". I really liked it back then and I could experiment on it furthermore after this PR.

@Mickeon Mickeon force-pushed the documentation-meta-underline-begone branch from 0fc709b to 61136ec Compare March 2, 2024 15:35
@Mickeon
Copy link
Contributor Author

Mickeon commented Mar 2, 2024

Updated the PR to make an exception for constants and enums for now. Improvements in styling will come in bulk at a later time and I'm looking forward to try them

@Chubercik
Copy link
Contributor

holy compression on these GIFs 😳

other than that looks good to me :)

@Mickeon
Copy link
Contributor Author

Mickeon commented Mar 5, 2024

Alright have a small video then!
https://github.com/godotengine/godot/assets/66727710/f83b0eff-cc8c-4aa0-8495-37968293fdfc

@Mickeon Mickeon force-pushed the documentation-meta-underline-begone branch from 61136ec to 635c64c Compare March 5, 2024 21:48
@Mickeon Mickeon force-pushed the documentation-meta-underline-begone branch from 635c64c to 3a0d056 Compare March 9, 2024 12:23
@Mickeon
Copy link
Contributor Author

Mickeon commented Mar 9, 2024

Rebased after the recent fun stuff. Would be nice to see this along with the other fruits of our labour.

@akien-mga akien-mga modified the milestones: 4.x, 4.3 Mar 9, 2024
@akien-mga akien-mga changed the title Use META_UNDERLINE_ON_HOVER in built-in class reference Use META_UNDERLINE_ON_HOVER in built-in class reference Mar 9, 2024
@akien-mga akien-mga merged commit 9234303 into godotengine:master Mar 9, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

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

Successfully merging this pull request may close these issues.

4 participants