godotengine / godotengine/godot-docs

Description of @abstract is easy to misunderstand

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

Description

**Your Godot version:**
4.5.1
**Issue description:**
In the description of the `@abstract` annotation it says:

> If a class has at least one abstract method (either its own or an unimplemented inherited one), then it must also be marked as abstract. However, the reverse is not true: an abstract class is allowed to have _no abstract methods_.

I think it should say "non abstract methods" instead, from context the sentence as it is right now makes no sense. I'm not a native speaker but I'm pretty sure the meaning is meant to be that an abstract class is allowed to have functions that are not abstract but the missing n reverses that meaning.

**URL to the documentation page:**
https://docs.godotengine.org/en/4.5/classes/class_@gdscript.html#class-gdscript-annotation-abstract

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://contributing.godotengine.org/en/latest/organization/pull_requests/creating_pull_requests.html,
writing documentation at https://contributing.godotengine.org/en/latest/documentation/guidelines/index.html
and contributing to the class reference here: https://contributing.godotengine.org/en/latest/documentation/class_reference.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.