godotengine / godotengine/godot-docs

Vector types unary not operator documentation is inconsistent

Open
#8,226 11 comments 0 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.1

**Issue description:**
The Vector 2 and 3 (and the int counterparts) class documentation for operators is missing a description for the unary not operator, `not value` / `!value`. There is a note at the end of the class description describing the behavior of boolean coercion but the first place I looked for what `!value` did was the operators section. It may be helpful to add `bool operator unary! ( )` to the unary operators section and describe the result and/or reference the note for boolean behavior. If the maintainers agree, it may be a good idea to apply this addition to all types/classes that support boolean coercion.

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_vector2.html
https://docs.godotengine.org/en/stable/classes/class_vector2i.html
https://docs.godotengine.org/en/stable/classes/class_vector3.html
https://docs.godotengine.org/en/stable/classes/class_vector3i.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.