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.

Sign up for GitHub

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

Jump to bottom

Add keywords to improve search in the class reference #88641

Merged
merged 1 commit into from
Feb 22, 2024
Merged

Add keywords to improve search in the class reference #88641

merged 1 commit into from
Feb 22, 2024

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Feb 21, 2024 •
edited
Loading

@Calinou Calinou added this to the 4.3 milestone Feb 21, 2024
@Calinou Calinou requested review from a team as code owners February 21, 2024 17:58
Mickeon
Mickeon reviewed Feb 21, 2024
View reviewed changes
doc/classes/Vector4.xml Outdated Show resolved Hide resolved
AThousandShips
AThousandShips reviewed Feb 21, 2024
View reviewed changes
doc/classes/@GlobalScope.xml Show resolved Hide resolved
doc/classes/Vector4.xml Outdated Show resolved Hide resolved
@Calinou Calinou requested a review from a team as a code owner February 21, 2024 18:26
Mickeon
Mickeon reviewed Feb 21, 2024
View reviewed changes
Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently the diff is outdated but I will publish what I had in the meantime

doc/classes/ReflectionProbe.xml Outdated Show resolved Hide resolved
doc/classes/Light3D.xml Outdated
@@ -88,12 +88,12 @@
<member name="light_negative" type="bool" setter="set_negative" getter="is_negative" default="false">
If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows.
</member>
<member name="light_projector" type="Texture2D" setter="set_projector" getter="get_projector">
<member name="light_projector" type="Texture2D" setter="set_projector" getter="get_projector" keywords="cookie">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Legitimately curious now. If it wasn't me someone else would've asked later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unity and some other 3D programs call them light cookies 🙂

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add "gobo" as well. That's how Source engine calls it.

doc/classes/Light3D.xml Outdated Show resolved Hide resolved
Mickeon
Mickeon reviewed Feb 21, 2024
View reviewed changes
doc/classes/AudioStreamPlayer.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamPlayer2D.xml Outdated Show resolved Hide resolved
doc/classes/AudioStreamPlayer3D.xml Outdated Show resolved Hide resolved
@Calinou Calinou force-pushed the doc-add-keywords branch 2 times, most recently from 18db484 to edb839b Compare February 21, 2024 19:05
@RedMser
Copy link
Contributor

RedMser commented Feb 22, 2024

Thank you so much for tackling this!
One request I have: I keep forgetting which of "editable, disabled, enabled and readonly" are used by which Controls, would be nice if all four keywords matched all related properties. At least later when the keywords are used to hint the gdscript auto complete, or filtering the inspector, it'll have more tangible benefits.

@Calinou
Copy link
Member Author

Calinou commented Feb 22, 2024

Thank you so much for tackling this! One request I have: I keep forgetting which of "editable, disabled, enabled and readonly" are used by which Controls, would be nice if all four keywords matched all related properties. At least later when the keywords are used to hint the gdscript auto complete, or filtering the inspector, it'll have more tangible benefits.

Done.

Mickeon
Mickeon approved these changes Feb 22, 2024
View reviewed changes
Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More can always be added later. This is a great start.

@akien-mga akien-mga merged commit b15105a into godotengine:master Feb 22, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon
Copy link
Contributor

Mickeon commented Feb 22, 2024

Caught you live 📸

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RedMser RedMser RedMser left review comments

@AThousandShips AThousandShips AThousandShips left review comments

@akien-mga akien-mga akien-mga approved these changes

@Mickeon Mickeon Mickeon approved these changes

Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
4.3
Development

Successfully merging this pull request may close these issues.
5 participants
@Calinou @RedMser @akien-mga @Mickeon @AThousandShips