Commit Graph

93 Commits

Author SHA1 Message Date
Tom
295b531e3d updated the String class with info about the 'allow_empty' optional argument
(cherry picked from commit 39233c299c)
2022-08-08 09:45:47 +02:00
0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
4834525242 Improve String.format() documentation
(cherry picked from commit 25c7f567dd)
2022-07-02 00:07:48 +02:00
6fb76ba266 Fix code example of String.is_valid_integer() 2022-06-25 10:10:27 +08:00
8235005c99 Fixing some of my own typos...
(and a little improvement to wording that was bugging me)

(cherry picked from commit 05718796db)
2022-04-13 11:43:49 +02:00
81eda4eee0 doc: Fix String.rsplit code example
Fixes #36898.
Supersedes and closes #36951.

(cherry picked from commit e7fd0ec31f)
2022-03-28 23:51:32 +02:00
b087538119 Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
94a5f9edb0 Fix capitalization of boolean output in classref 2022-03-09 21:56:55 +08:00
c4041ca8c0 Added or improved documentation to a few more String methods
(cherry picked from commit f159e7e5ab)
2022-03-02 11:00:26 +01:00
54eac2aba5 Update doc for match: empty argument doesn't match anything
(cherry picked from commit 70ae6c21de)
2022-03-02 11:00:26 +01:00
5ca3a360d1 Clarify identical hash() return values due to collisions
(cherry picked from commit 08541fe11d)
2022-02-15 12:27:57 +01:00
ccb52db232 Clarify to_float() and to_int() methods
(cherry picked from commit 7bb682651f)
2022-01-19 16:04:16 +01:00
d03b82cde7 Expose String::join over to GDScript 2021-12-30 21:27:18 -05:00
c11b1850c4 Make --doctool locale aware
* Adds `indent(prefix)` to `String`
* Moves the loading of tool/doc translation into
  `editor/editor_translation.{h,cpp}`
* Makes use of doc translation when generating XML class references, and
  setup the translation locale based on `-l LOCALE` CLI parameter.

The XML class reference won't be translated if `-l LOCALE` parameter is
not given, or when it's `-l en`.
2021-12-16 18:27:32 +08:00
b1153f8829 Fix broken links in Class Reference 2021-12-10 21:07:21 +08:00
3ac2999f22 Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
7f91cbc397 Expose String.get_slice
(cherry picked from commit e5725c7deb)
2021-11-15 17:22:46 +01:00
14c366ddd7 Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
415b7a7bfc Improve documentation for String.get_extension()
(cherry picked from commit 09eb98c530)
2021-09-21 17:14:58 +02:00
f5409e7c3f Fixed String::simplify_path Variant return type 2021-08-29 20:25:00 -04:00
fb5417a17b [3.x] Expose String.simplify_path 2021-08-24 00:48:20 -04:00
f0b37b1519 doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
abc18e9a4f Fix Unicode URL link tags to render correctly.
Change incorrect `[/code]` closing tags to `[/url]` tags.

The `url` tags for the links to the Unicode code points information use `[/code]` rather than `[/url]` to close them.

This results in the links being rendered incorrectly in the IDE--the entire rest of the documentation for each method gets turned into a giant underlined link.

This issue was introduced in a2271ba3bd.

(cherry picked from commit b85688ac7d)
2021-08-12 16:42:16 +02:00
f5836b40d4 doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00
c3272997cd doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
015973df04 doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
1aba997d75 doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
b032067e42 Relaxes Node naming constraints in glTF documents to match the Editor. 2021-03-12 08:35:50 -08:00
5bbacc85bd Expose String contents to the GDScript as PoolByteArray. 2021-02-23 13:43:36 +02:00
0abf702d4b Merge pull request #45957 from lupoDharkael/natural-comp
[3.2] Add natural string comparison
2021-02-22 11:07:54 +01:00
460e1b94c3 [3.2] Add natural string comparison 2021-02-13 15:13:58 +01:00
9c9ac159e9 Clarify lstrip()/rstrip() methods in String for removed characters
(cherry picked from commit a2c82bbf5f)
2021-01-13 16:17:09 +01:00
4287af5148 doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
016ea497eb Improve the String.is_valid_ip_address() documentation
This closes https://github.com/godotengine/godot-docs/issues/4097.

(cherry picked from commit 00ade39389)
2020-10-01 16:00:47 +02:00
867b0d57d6 Improve the String comparison methods' documentation
This closes https://github.com/godotengine/godot-docs/issues/4096.

(cherry picked from commit a2271ba3bd)
2020-10-01 16:00:47 +02:00
4a0568b609 Document how to perform advanced string splitting using RegEx
This closes https://github.com/godotengine/godot-docs/issues/3607.

(cherry picked from commit 5f2b6bd476)
2020-07-29 18:24:00 +02:00
b717a61903 Improve the Object, Reference and Resource class documentations
(cherry picked from commit 4275e6aad5)
2020-07-28 00:48:33 +02:00
5c7802a061 Document which escape sequences are supported by String.c_unescape()
See https://github.com/godotengine/godot/issues/38716.

(cherry picked from commit 04b25108ac)
2020-07-24 10:31:57 +02:00
d4f4e0d7dc Fix String.capitalize() description to follow camelCase changes
This closes #40093.

(cherry picked from commit 887099680a)
2020-07-06 14:16:49 +02:00
d2347bc4ec Clarify what a string being empty means
Should close https://github.com/godotengine/godot-docs/issues/2432

(cherry picked from commit 2643b8fa5e)
2020-06-24 22:52:05 +02:00
5a1f94ba47 Document the in operator in String, Array and Dictionary classes
This also clarifies the `in` operator behavior in Object.

(cherry picked from commit 7f01f68226)
2020-06-15 14:34:34 +02:00
df2a2ae0fc DocData: Fix serialization of Variant default values
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit 788765709d)
2020-03-09 11:36:57 +01:00
2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
ae76c62601 Implement Node::get_process_priority() and its associated property
This closes #33660.
2019-11-17 17:48:50 +01:00
d3a852f124 Merge pull request #33591 from zaksnet/fix-string-docs-split
Fix split/rsplit docs
2019-11-13 14:03:14 +01:00
Zak
79aca6b0c0 Fix split/rsplit docs 2019-11-13 14:58:19 +02:00
121fb46ab9 Clarify that String.insert returns a copy
Supersedes and closes #32620.
2019-11-07 13:12:06 +01:00
a0d00c0e99 Bind the String::humanize_size method
The method signature is also changed to use `uint64_t` instead of `size_t`
for it to be Variant-compatible.
2019-10-04 15:51:13 +03:00
a7ac8ec876 doc: Fix parsing of self-closing XML tags
Follow-up to #31925, `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.

Also added space before closing `/>`.
2019-09-24 13:34:05 +02:00
073f625a91 Create a GDScript String function repeat
Fixes #30610
2019-09-03 13:06:13 -04:00