godotengine / godotengine/godot-docs

A miriad of Classes/Functions does not have the platform scope documented. (Specially HTML5)

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

Description

### Tested versions

3.x (and certanly 4.x?)

### System information

.

### Issue description

As said in title, several classes that one may ponder if they work or not, is not clearly documented if they do.

I am at this moment bruteforcing a list of classes i need on web, to check if they are available.

As a first example, "IP", does not. but there is no place in the docs that it says so.

This is most certanly a problem in the HTML export, but android and ios may be affected as well, i supose.

Having a unified clear section in the documentation of each class, that declares all the platforms this class does not behave as expected/is not implemented, is needed.

This is already done in some classes, and some methods, indeed.

What i propose is a refactor of the documentation to clearly include the lacking/unbehaviour in implementation of each class, in a concise way.

The way it is done now, is on a case by case basis, and not fully covered.

Having this is both a incentive, if a non-implemented feature can be implemented (like webcam, only implemented on Apple), and a clear delimitation to platform specifc development(Like OS.execute(), that because of sandboxing will never be available on WEB, that is too, not documented as unavailable, even if obvious.)

### Steps to reproduce

check documentation

### Minimal reproduction project (MRP)

none

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.