Skip to content

Improve doc for bool operators#117281

Merged
Repiteo merged 1 commit into
godotengine:masterfrom
EdwardChanCH:improve_doc_bool_op
Apr 20, 2026
Merged

Improve doc for bool operators#117281
Repiteo merged 1 commit into
godotengine:masterfrom
EdwardChanCH:improve_doc_bool_op

Conversation

@EdwardChanCH

@EdwardChanCH EdwardChanCH commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Related PR:

Changes:

  • Makes bool class operator descriptions for == and != more consistent in style with <, and >.
@EdwardChanCH EdwardChanCH requested a review from a team as a code owner March 10, 2026 08:35
Comment thread doc/classes/bool.xml Outdated
Comment thread doc/classes/bool.xml Outdated
@EdwardChanCH

Copy link
Copy Markdown
Contributor Author

I'd keep the same order in both

Updated.

@AThousandShips AThousandShips left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Repiteo Repiteo modified the milestones: 4.x, 4.7 Apr 20, 2026
@Repiteo Repiteo merged commit 5e9ac69 into godotengine:master Apr 20, 2026
7 checks passed
@Repiteo

Repiteo commented Apr 20, 2026

Copy link
Copy Markdown
Contributor

Thanks!

@Mickeon

Mickeon commented Apr 24, 2026

Copy link
Copy Markdown
Member

more consistent in style.

In relation to what? I assume prior the PRs, but there's somewhat arbitrary arbitrary [b] tags encompassing XOR and EQ, for some reason.

The new descriptions are notably more technical, but they do not need to be. Let's keep in mind who is going to read the class reference, especially for the atomic Variant types. Users with all sorts of backgrounds in both English and programming languages alike.

"The two booleans are not equal" and "one operand is false and the other operand is true". Both are correct, but the former is way more succinct and snappy. It also rightfully assumes most users have a general grasp on what "equal" means.

Not too fond of this PR, I don't feel like this was necessary.

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