Commit Graph

144 Commits

Author SHA1 Message Date
346efd29e0 Fix typos with codespell 2022-12-15 12:24:08 +01:00
3afe5d0c25 Fix docstring for String.get_base_dir 2022-12-12 13:12:25 -05:00
45e991fdc2 Update StringName documentation to match String's 2022-12-09 20:03:40 +01:00
907298d673 Merge pull request #68747 from rune-scape/rune-stringname-unification
GDScript: Unify StringName and String
2022-12-09 18:06:48 +01:00
e79be6ce07 Unify String and StringName 2022-12-05 21:46:47 -05:00
3b71d85f9f Overhaul String Documentation 2022-12-05 20:33:47 +01:00
f05a55ef95 Merge pull request #68217 from Mickeon/doc-stringmngffh
Add missing String & StringName operator descriptions
2022-11-23 21:28:17 +01:00
c164f1835c Add missing String & StringName operator descriptions 2022-11-23 18:56:39 +01:00
e791f4fce2 Double precision of String.split_floats 2022-11-20 12:29:50 +01:00
1959284769 Merge pull request #68229 from Mickeon/c-escape-hell
Remove "?" from String.c_escape()
2022-11-14 23:24:35 +01:00
8a47a12207 Add support for empty delimiter in String.split 2022-11-04 15:09:12 +01:00
521d8a5d24 Remove "?" from String.c_escape() 2022-11-03 19:52:21 +01:00
f7c611ab71 Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-02 19:01:18 +01:00
d3a6855dfc Merge pull request #66361 from dalexeev/remove-int-plus-string
Unexpose confusing `String + int` and `int + String` operations
2022-11-02 18:51:16 +01:00
05a9637d5d Fix small mistakes throughout much of the documentation 2022-10-21 00:20:59 +02:00
453c5ef682 Remove confusing String + int and int + String operations 2022-09-24 18:13:44 +03:00
d4555ef5fb Add String.to_{camel,pascal,snake}_case methods 2022-08-30 12:36:24 +03:00
10a56981dc Rename String plus_file to path_join 2022-08-29 19:38:13 -05:00
28e66882e5 [doc] Fix grammar in class docs: amount vs. number
Number is used for things that can be counted (discrete items - think "integer" in this context).

Also fixes a couple of awkward phrases.
2022-08-17 19:51:17 -04:00
1f72f48361 [doc] Use "param" instead of "code" to refer to parameters #3 2022-08-09 22:00:19 -04:00
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Tom
39233c299c updated the String class with info about the 'allow_empty' optional argument 2022-08-05 23:10:16 +01:00
25c7f567dd Improve String.format() documentation 2022-06-27 11:29:44 +08:00
6f38c21253 Fix parameter name for String.left and String.right 2022-06-12 16:34:44 +08:00
05718796db Fixing some of my own typos...
(and a little improvement to wording that was bugging me)
2022-03-31 14:20:37 -04:00
e7fd0ec31f doc: Fix String.rsplit code example
Fixes #36898.
Supersedes and closes #36951.
2022-03-26 15:05:05 +01:00
f19cd44346 Unify TextServer built-in module and GDExtension code. 2022-03-17 08:15:29 +02:00
32f2c47356 Remove generating of null comparison operators from documentation 2022-03-14 22:35:23 +03:00
f159e7e5ab Added or improved documentation to a few more String methods 2022-02-23 10:50:33 -05:00
b2b2e0606f Document String's humanize_size static method 2022-02-22 13:12:29 -05:00
70ae6c21de Update doc for match: empty argument doesn't match anything 2022-02-21 09:37:29 +01:00
b68dd2e189 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-02-15 00:03:31 +01:00
08541fe11d Clarify identical hash() return values due to collisions 2022-02-12 22:21:37 +01:00
b801742b77 [GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 09:49:14 +02:00
adbe948bda String: Add contains(). 2022-02-04 01:28:02 +05:45
3eb5e0ac50 Rename String::is_subsequence_ofi to String::is_subsequence_ofn 2022-01-26 18:03:56 -05:00
7bb682651f Clarify to_float() and to_int() methods 2022-01-17 16:44:07 +01:00
2cad775461 Fix usage of "Return" in the docs 2022-01-02 21:09:18 +01:00
e4e4e475f8 Make --doctool locale aware
* Adds `indent(str)` to `String`:
    * Indent the (multiline) string with the given indentation.
    * This method is added in order to keep the translated XML correctly
      indented.
* Moves the loading of tool/doc translation into
  `editor/editor_translation.{h,cpp}`.
    * This will be used from both `EditorSettings` and the doc tool from
      `main`.
* 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 17:49:22 +08:00
6c1bd4d227 Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
ab6ec9310c Merge pull request #54453 from KoBeWi/slice_of_string 2021-11-02 13:18:34 +01:00
e5725c7deb Expose String.get_slice 2021-11-02 11:24:07 +01:00
6772ebcea0 Move the docs for constructors and operators out of methods section 2021-10-29 12:34:57 -05:00
baa83012ef Fix bin_to_int documentation examples
The `bin_to_int` method uses the `0b` prefix.
2021-10-22 01:57:34 +02:00
862994a8ef doc: Update links to latest documentation after content reorganization 2021-10-06 13:48:48 +02:00
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
262d9397fb Allow indexing of String values in scripting languages 2021-09-17 16:24:56 -03:00
455e142d37 Allow comparing equality between builtin types and null 2021-09-17 12:33:52 -03:00
d11c1afc04 Rename String::is_rel_path to String::is_relative_path 2021-08-29 20:41:29 -04:00
7e0f1fa2ec Merge pull request #52041 from Rubonnek/expose-simplify-path
Expose `String.simplify_path`
2021-08-24 17:06:16 +02:00