Skip to content

Commit 0a06ecb

Browse files
committed
fix: skip non-public functions and improve overload handling
1 parent 2c7343f commit 0a06ecb

File tree

21 files changed

+216
-310
lines changed

21 files changed

+216
-310
lines changed

content/reference/python/actor.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,25 @@ Represents a base actor in the level.
3030
</tr>
3131
</thead>
3232
<tbody>
33-
<tr key="1-add_scoreboard_tag">
33+
<tr key="add_scoreboard_tag">
3434
<td>[`add_scoreboard_tag`](#endstone.actor.Actor.add_scoreboard_tag)</td>
3535
<td>Adds a tag to this actor.</td>
3636
</tr>
37-
<tr key="2-remove">
37+
<tr key="remove">
3838
<td>[`remove`](#endstone.actor.Actor.remove)</td>
3939
<td>Remove this actor from the level.</td>
4040
</tr>
41-
<tr key="3-remove_scoreboard_tag">
41+
<tr key="remove_scoreboard_tag">
4242
<td>[`remove_scoreboard_tag`](#endstone.actor.Actor.remove_scoreboard_tag)</td>
4343
<td>Removes a given tag from this actor.</td>
4444
</tr>
45-
<tr key="4-set_rotation">
45+
<tr key="set_rotation">
4646
<td>[`set_rotation`](#endstone.actor.Actor.set_rotation)</td>
4747
<td>Sets the actor's rotation.</td>
4848
</tr>
49-
<tr key="5-teleport">
49+
<tr key="teleport">
5050
<td>[`teleport`](#endstone.actor.Actor.teleport)</td>
51-
<td>Teleports this actor to the given location.</td>
52-
</tr>
53-
<tr key="6-teleport">
54-
<td>[`teleport`](#endstone.actor.Actor.teleport)</td>
55-
<td>Teleports this actor to the target Actor.</td>
51+
<td>Teleports this actor to the given location.<br/>Teleports this actor to the target Actor.</td>
5652
</tr></tbody>
5753
</table>
5854

content/reference/python/ban.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,19 @@ Represents a ban list containing banned IP addresses.
6969
</tr>
7070
</thead>
7171
<tbody>
72-
<tr key="1-add_ban">
72+
<tr key="add_ban">
7373
<td>[`add_ban`](#endstone.ban.IpBanList.add_ban)</td>
7474
<td>Adds a ban to this list, or updates an existing one.</td>
7575
</tr>
76-
<tr key="2-get_ban_entry">
76+
<tr key="get_ban_entry">
7777
<td>[`get_ban_entry`](#endstone.ban.IpBanList.get_ban_entry)</td>
7878
<td>Gets a BanEntry by IP address.</td>
7979
</tr>
80-
<tr key="3-is_banned">
80+
<tr key="is_banned">
8181
<td>[`is_banned`](#endstone.ban.IpBanList.is_banned)</td>
8282
<td>Checks if a BanEntry exists for the target by IP address.</td>
8383
</tr>
84-
<tr key="4-remove_ban">
84+
<tr key="remove_ban">
8585
<td>[`remove_ban`](#endstone.ban.IpBanList.remove_ban)</td>
8686
<td>Removes an IP address from the ban list.</td>
8787
</tr></tbody>
@@ -234,19 +234,19 @@ Represents a ban list containing banned players.
234234
</tr>
235235
</thead>
236236
<tbody>
237-
<tr key="1-add_ban">
237+
<tr key="add_ban">
238238
<td>[`add_ban`](#endstone.ban.PlayerBanList.add_ban)</td>
239239
<td>Adds a ban to this list, or updates an existing one.</td>
240240
</tr>
241-
<tr key="2-get_ban_entry">
241+
<tr key="get_ban_entry">
242242
<td>[`get_ban_entry`](#endstone.ban.PlayerBanList.get_ban_entry)</td>
243243
<td>Gets a BanEntry by player name, UUID, or XUID.</td>
244244
</tr>
245-
<tr key="3-is_banned">
245+
<tr key="is_banned">
246246
<td>[`is_banned`](#endstone.ban.PlayerBanList.is_banned)</td>
247247
<td>Checks if a BanEntry exists for the target by name, UUID, or XUID.</td>
248248
</tr>
249-
<tr key="4-remove_ban">
249+
<tr key="remove_ban">
250250
<td>[`remove_ban`](#endstone.ban.PlayerBanList.remove_ban)</td>
251251
<td>Removes a player from the ban list by name, UUID, or XUID.</td>
252252
</tr></tbody>

content/reference/python/block.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,19 @@ Represents a block.
2929
</tr>
3030
</thead>
3131
<tbody>
32-
<tr key="1-capture_state">
32+
<tr key="capture_state">
3333
<td>[`capture_state`](#endstone.block.Block.capture_state)</td>
3434
<td>Captures the current state of this block. The returned object will never be updated, and you are not guaranteed that (for example) a sign is still a sign after you capture its state.</td>
3535
</tr>
36-
<tr key="2-get_relative">
36+
<tr key="get_relative">
3737
<td>[`get_relative`](#endstone.block.Block.get_relative)</td>
38-
<td>Gets the block at the given offsets</td>
38+
<td>Gets the block at the given offsets<br/>Gets the block at the given distance of the given face</td>
3939
</tr>
40-
<tr key="3-get_relative">
41-
<td>[`get_relative`](#endstone.block.Block.get_relative)</td>
42-
<td>Gets the block at the given distance of the given face</td>
43-
</tr>
44-
<tr key="4-set_data">
40+
<tr key="set_data">
4541
<td>[`set_data`](#endstone.block.Block.set_data)</td>
4642
<td>Sets the complete data for this block</td>
4743
</tr>
48-
<tr key="5-set_type">
44+
<tr key="set_type">
4945
<td>[`set_type`](#endstone.block.Block.set_type)</td>
5046
<td>Sets the type of this block</td>
5147
</tr></tbody>
@@ -382,7 +378,7 @@ Represents a captured state of a block, which will not update automatically.
382378
</tr>
383379
</thead>
384380
<tbody>
385-
<tr key="1-update">
381+
<tr key="update">
386382
<td>[`update`](#endstone.block.BlockState.update)</td>
387383
<td>Attempts to update the block represented by this state.</td>
388384
</tr></tbody>

content/reference/python/boss.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -318,27 +318,27 @@ Represents a boss bar that is displayed to players.
318318
</tr>
319319
</thead>
320320
<tbody>
321-
<tr key="1-add_flag">
321+
<tr key="add_flag">
322322
<td>[`add_flag`](#endstone.boss.BossBar.add_flag)</td>
323323
<td>Adds an optional flag to this boss bar.</td>
324324
</tr>
325-
<tr key="2-add_player">
325+
<tr key="add_player">
326326
<td>[`add_player`](#endstone.boss.BossBar.add_player)</td>
327327
<td>Adds the player to this boss bar causing it to display on their screen.</td>
328328
</tr>
329-
<tr key="3-has_flag">
329+
<tr key="has_flag">
330330
<td>[`has_flag`](#endstone.boss.BossBar.has_flag)</td>
331331
<td>Checks whether this boss bar has the passed flag set.</td>
332332
</tr>
333-
<tr key="4-remove_all">
333+
<tr key="remove_all">
334334
<td>[`remove_all`](#endstone.boss.BossBar.remove_all)</td>
335335
<td>Removes all players from this boss bar.</td>
336336
</tr>
337-
<tr key="5-remove_flag">
337+
<tr key="remove_flag">
338338
<td>[`remove_flag`](#endstone.boss.BossBar.remove_flag)</td>
339339
<td>Removes an existing flag on this boss bar.</td>
340340
</tr>
341-
<tr key="6-remove_player">
341+
<tr key="remove_player">
342342
<td>[`remove_player`](#endstone.boss.BossBar.remove_player)</td>
343343
<td>Removes the player from this boss bar causing it to be removed from their screen.</td>
344344
</tr></tbody>

content/reference/python/command.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ Represents a Command, which executes various tasks upon user input
7979
</tr>
8080
</thead>
8181
<tbody>
82-
<tr key="1-execute">
82+
<tr key="execute">
8383
<td>[`execute`](#endstone.command.Command.execute)</td>
8484
<td>Executes the command, returning its success</td>
8585
</tr>
86-
<tr key="2-test_permission">
86+
<tr key="test_permission">
8787
<td>[`test_permission`](#endstone.command.Command.test_permission)</td>
8888
<td>Tests the given CommandSender to see if they can perform this command.</td>
8989
</tr>
90-
<tr key="3-test_permission_silently">
90+
<tr key="test_permission_silently">
9191
<td>[`test_permission_silently`](#endstone.command.Command.test_permission_silently)</td>
9292
<td>Tests the given CommandSender to see if they can perform this command. No error is sent to the sender.</td>
9393
</tr></tbody>
@@ -230,7 +230,7 @@ Represents a class which contains a single method for executing commands
230230
</tr>
231231
</thead>
232232
<tbody>
233-
<tr key="1-on_command">
233+
<tr key="on_command">
234234
<td>[`on_command`](#endstone.command.CommandExecutor.on_command)</td>
235235
<td>Executes the given command, returning its success.</td>
236236
</tr></tbody>
@@ -264,11 +264,11 @@ Represents a command sender.
264264
</tr>
265265
</thead>
266266
<tbody>
267-
<tr key="1-send_error_message">
267+
<tr key="send_error_message">
268268
<td>[`send_error_message`](#endstone.command.CommandSender.send_error_message)</td>
269269
<td>Sends this sender an error message</td>
270270
</tr>
271-
<tr key="2-send_message">
271+
<tr key="send_message">
272272
<td>[`send_message`](#endstone.command.CommandSender.send_message)</td>
273273
<td>Sends this sender a message</td>
274274
</tr></tbody>

content/reference/python/enchantments.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Name | Description
2424
</tr>
2525
</thead>
2626
<tbody>
27-
<tr key="1-can_enchant_item">
27+
<tr key="can_enchant_item">
2828
<td>[`can_enchant_item`](#endstone.enchantments.Enchantment.can_enchant_item)</td>
2929
<td>Checks if this Enchantment may be applied to the given ItemStack.</td>
3030
</tr>
31-
<tr key="2-conflicts_with">
31+
<tr key="conflicts_with">
3232
<td>[`conflicts_with`](#endstone.enchantments.Enchantment.conflicts_with)</td>
3333
<td>Check if this enchantment conflicts with another enchantment.</td>
3434
</tr></tbody>

content/reference/python/event.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Name | Description
8181
</tr>
8282
</thead>
8383
<tbody>
84-
<tr key="1-event_handler">
84+
<tr key="event_handler">
8585
<td>[`event_handler`](#endstone.event.event_handler)</td>
8686
<td></td>
8787
</tr></tbody>
@@ -692,7 +692,7 @@ Represents an event that may be cancelled by a plugin or the server.
692692
</tr>
693693
</thead>
694694
<tbody>
695-
<tr key="1-cancel">
695+
<tr key="cancel">
696696
<td>[`cancel`](#endstone.event.Cancellable.cancel)</td>
697697
<td>Cancel this event. A cancelled event will not be executed in the server, but will still pass to other plugins.</td>
698698
</tr></tbody>

content/reference/python/form.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ Represents a form with buttons that let the player take action.
4747
</tr>
4848
</thead>
4949
<tbody>
50-
<tr key="1-add_button">
50+
<tr key="add_button">
5151
<td>[`add_button`](#endstone.form.ActionForm.add_button)</td>
5252
<td>Adds a button to the form.</td>
5353
</tr>
54-
<tr key="2-add_divider">
54+
<tr key="add_divider">
5555
<td>[`add_divider`](#endstone.form.ActionForm.add_divider)</td>
5656
<td>Adds a divider to the form.</td>
5757
</tr>
58-
<tr key="3-add_header">
58+
<tr key="add_header">
5959
<td>[`add_header`](#endstone.form.ActionForm.add_header)</td>
6060
<td>Adds a header to the form.</td>
6161
</tr>
62-
<tr key="4-add_label">
62+
<tr key="add_label">
6363
<td>[`add_label`](#endstone.form.ActionForm.add_label)</td>
6464
<td>Adds a label to the form.</td>
6565
</tr></tbody>
@@ -285,7 +285,7 @@ Represents a dropdown with a set of predefined options.
285285
</tr>
286286
</thead>
287287
<tbody>
288-
<tr key="1-add_option">
288+
<tr key="add_option">
289289
<td>[`add_option`](#endstone.form.Dropdown.add_option)</td>
290290
<td>Adds a new option to the dropdown.</td>
291291
</tr></tbody>
@@ -578,7 +578,7 @@ Represents a modal form with controls.
578578
</tr>
579579
</thead>
580580
<tbody>
581-
<tr key="1-add_control">
581+
<tr key="add_control">
582582
<td>[`add_control`](#endstone.form.ModalForm.add_control)</td>
583583
<td>Adds a control to the form.</td>
584584
</tr></tbody>
@@ -826,7 +826,7 @@ Represents a step slider with a set of predefined options.
826826
</tr>
827827
</thead>
828828
<tbody>
829-
<tr key="1-add_option">
829+
<tr key="add_option">
830830
<td>[`add_option`](#endstone.form.StepSlider.add_option)</td>
831831
<td>Adds a new option to the step slider.</td>
832832
</tr></tbody>

0 commit comments

Comments
 (0)