godotengine / godotengine/godot-docs

Incorrect OS.get_cmdline_args() usage example

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

Description

**Your Godot version:**
4.4.1

**Issue description:**
In the documentation for `OS.get_cmdline_user_args()`, an example usage of `OS.get_cmdline_args()` shows it returning `--fullscreen`. If you try this yourself, godot won't actually return `--fullscreen` or any other inbuilt engine arguments I could find.

It's a little unclear if this is intended behavior: https://github.com/godotengine/godot/issues/92831
If it is, the documentation for `OS.get_cmdline_args()` should also state it explicitly.

**URL to the documentation page:**
https://docs.godotengine.org/en/stable/classes/class_os.html#class-os-method-get-cmdline-user-args

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.