Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General function description updates #35

Merged
merged 11 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions api/functions/Card/IsContinuousSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsContinuousSpell
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Continuous Spell](https://yugipedia.com/wiki/Continuous_Spell_Card).
summary: Checks if a card is a Continuous Spell
Checks if a card is currently a [Continuous Spell](https://yugipedia.com/wiki/Continuous_Spell_Card).
summary: Checks if a card is currently a Continuous Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Continuous Spell.
description: >-
`true` if the card is currently a Continuous Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
9 changes: 4 additions & 5 deletions api/functions/Card/IsContinuousSpellTrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
name: IsContinuousSpellTrap
namespace: Card
description: >-
Returns `true` if the given card is currently a
[Continuous Spell](https://yugipedia.com/wiki/Continuous_Spell_Card)
**or** [Continuous Trap](https://yugipedia.com/wiki/Continuous_Trap_Card).
summary: Checks if a card is a Continuous Spell or Trap
Checks if a card is currently a Continuous [Spell](https://yugipedia.com/wiki/Continuous_Spell_Card)/[Trap](https://yugipedia.com/wiki/Continuous_Trap_Card).
summary: Checks if a card is currently a Continuous Spell/Trap.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Continuous Spell or Trap.
description: >-
`true` if the card is currently a Continuous Spell/Trap, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsContinuousTrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsContinuousTrap
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Continuous Spell](https://yugipedia.com/wiki/Continuous_Trap_Card).
summary: Checks if a card is a Continuous Spell
Checks if a card is currently a [Continuous Trap](https://yugipedia.com/wiki/Continuous_Trap_Card).
summary: Checks if a card is currently a Continuous Trap.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Continuous Spell.
description: >-
`true` if the card is currently a Continuous Trap, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsCounterTrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsCounterTrap
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Counter Trap](https://yugipedia.com/wiki/Counter_Trap_Card).
summary: Checks if a card is a Counter Trap
Checks if a card is currently a [Counter Trap](https://yugipedia.com/wiki/Counter_Trap_Card).
summary: Checks if a card is currently a Counter Trap.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Counter Trap.
description: >-
`true` if the card is currently a Counter Trap, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
12 changes: 4 additions & 8 deletions api/functions/Card/IsEquipCard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@
name: IsEquipCard
namespace: Card
description: >-
Returns `true` if the given card is currently
an [Equip Card](https://yugipedia.com/wiki/Equip_Card).
summary: Checks if a card is an Equip Card
Checks if a card is currently a [Equip Card](https://yugipedia.com/wiki/Equip_Card).
summary: Checks if a card is currently a Equip Card.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently an Equip Card.
description: >-
`true` if the card is currently a Equip Card, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
suggestedLinks:
- name: Card.IsEquipSpell
link: /api/functions/Card/IsEquipCard
message: To check for Equip Spells specifically
8 changes: 4 additions & 4 deletions api/functions/Card/IsEquipSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsEquipSpell
namespace: Card
description: >-
Returns `true` if the given card is currently
an [Equip Spell](https://yugipedia.com/wiki/Equip_Spell_Card).
summary: Checks if a card is an Equip Spell
Checks if a card is currently a [Equip Spell](https://yugipedia.com/wiki/Equip_Spell_Card).
summary: Checks if a card is currently a Equip Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently an Equip Spell.
description: >-
`true` if the card is currently a Equip Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
13 changes: 7 additions & 6 deletions api/functions/Card/IsFacedown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
name: IsFacedown
namespace: Card
description: >-
Checks if a card (Card c) is face-down
status:
index: stable
Checks if a card is currently face-down.
summary: Checks if a card is currently face-down.
parameters:
- name: c
type: [ Card ]
description: (To be added)
description: The card to check.
returns:
- type: [ bool ]
description: (To be added)
tags: [ under-construction ]
description: >-
`true` if the card is currently face-down, `false` otherwise.
status: { index: stable }
tags: [ card-check ]
13 changes: 7 additions & 6 deletions api/functions/Card/IsFaceup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
name: IsFaceup
namespace: Card
description: >-
Checks if a card (Card c) is face-up
status:
index: stable
Checks if a card is currently face-up.
summary: Checks if a card is currently face-up.
parameters:
- name: c
type: [ Card ]
description: (To be added)
description: The card to check.
returns:
- type: [ bool ]
description: (To be added)
tags: [ under-construction ]
description: >-
`true` if the card is currently face-up, `false` otherwise.
status: { index: stable }
tags: [ card-check ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsFieldSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsFieldSpell
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Field Spell](https://yugipedia.com/wiki/Field_Spell_Card).
summary: Checks if a card is a Field Spell
Checks if a card is currently a [Field Spell](https://yugipedia.com/wiki/Field_Spell_Card).
summary: Checks if a card is currently a Field Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Field Spell.
description: >-
`true` if the card is currently a Field Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsLinkMonster.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsLinkMonster
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Link Monster](https://yugipedia.com/wiki/Link_Monster).
summary: Checks if a card is a Link Monster
Checks if a card is currently a [Link Monster](https://yugipedia.com/wiki/Link_Monster).
summary: Checks if a card is currently a Link Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Link Monster.
description: >-
`true` if the card is currently a Link Monster, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsLinkSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsLinkSpell
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Link Spell](https://yugipedia.com/wiki/Link_Spell_Card).
summary: Checks if a card is a Link Spell
Checks if a card is currently a [Link Spell](https://yugipedia.com/wiki/Link_Spell_Card).
summary: Checks if a card is currently a Link Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Link Spell.
description: >-
`true` if the card is currently a Link Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
7 changes: 4 additions & 3 deletions api/functions/Card/IsMonster.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
name: IsMonster
namespace: Card
description: >-
Returns `true` if the given card is currently a [monster](https://yugipedia.com/wiki/Monster_Card).
summary: Checks if a card is a monster
Checks if a card is currently a [monster](https://yugipedia.com/wiki/Monster_Card).
summary: Checks if a card is currently a monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a monster.
description: >-
`true` if the card is currently a monster, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
7 changes: 4 additions & 3 deletions api/functions/Card/IsMonsterCard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
name: IsMonsterCard
namespace: Card
description: >-
Returns `true` if the given card is originally a [Monster Card](https://yugipedia.com/wiki/Monster_Card).
summary: Checks if a card is originally a Monster Card
Checks if a card is originally a [Monster Card](https://yugipedia.com/wiki/Monster_Card).
summary: Checks if a card is originally a Monster Card.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is originally a Monter Card.
description: >-
`true` if the card is originally a Monster Card, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related, original-property ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsNormalSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsNormalSpell
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Normal Spell](https://yugipedia.com/wiki/Normal_Spell_Card).
summary: Checks if a card is a Normal Spell
Checks if a card is currently a [Normal Spell](https://yugipedia.com/wiki/Normal_Spell_Card).
summary: Checks if a card is currently a Normal Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Normal Spell.
description: >-
`true` if the card is currently a Normal Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
9 changes: 4 additions & 5 deletions api/functions/Card/IsNormalSpellTrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
name: IsNormalSpellTrap
namespace: Card
description: >-
Returns `true` if the given card is currently a
[Normal Spell](https://yugipedia.com/wiki/Normal_Spell_Card)
**or** [Normal Trap](https://yugipedia.com/wiki/Normal_Trap_Card).
summary: Checks if a card is a Normal Spell or Trap
Checks if a card is currently a Normal [Spell](https://yugipedia.com/wiki/Normal_Spell_Card)/[Trap](https://yugipedia.com/wiki/Normal_Trap_Card).
summary: Checks if a card is currently a Normal Spell/Trap.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Normal Spell or Trap.
description: >-
`true` if the card is currently a Normal Spell/Trap, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsNormalTrap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsNormalTrap
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Normal Trap](https://yugipedia.com/wiki/Normal_Trap_Card).
summary: Checks if a card is a Normal Trap
Checks if a card is currently a [Normal Trap](https://yugipedia.com/wiki/Normal_Trap_Card).
summary: Checks if a card is currently a Normal Trap.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Normal Trap.
description: >-
`true` if the card is currently a Normal Trap, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
13 changes: 7 additions & 6 deletions api/functions/Card/IsOnField.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
name: IsOnField
namespace: Card
description: >-
Checks if a card (Card c) is located on the field
status:
index: stable
Checks if a card is currently on the field.
summary: Checks if a card is currently on the field.
parameters:
- name: c
type: [ Card ]
description: (To be added)
description: The card to check.
returns:
- type: [ bool ]
description: (To be added)
tags: [ under-construction ]
description: >-
`true` if the card is currently on the field, `false` otherwise.
status: { index: stable }
tags: [ card-check ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsQuickPlaySpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsQuickPlaySpell
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Quick-Play Spell](https://yugipedia.com/wiki/Quick-Play_Spell_Card).
summary: Checks if a card is a Quick-Play Spell
Checks if a card is currently a [Quick-Play Spell](https://yugipedia.com/wiki/Quick-Play_Spell_Card).
summary: Checks if a card is currently a Quick-Play Spell.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Quick-Play Spell.
description: >-
`true` if the card is currently a Quick-Play Spell, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
8 changes: 4 additions & 4 deletions api/functions/Card/IsRitualMonster.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: IsRitualMonster
namespace: Card
description: >-
Returns `true` if the given card is currently
a [Ritual Monster](https://yugipedia.com/wiki/Ritual_Monster).
summary: Checks if a card is a Ritual Monster
Checks if a card is currently a [Ritual Monster](https://yugipedia.com/wiki/Ritual_Monster).
summary: Checks if a card is currently a Ritual Monster.
parameters:
- name: c
type: [ Card ]
description: The card to check.
returns:
- type: [ bool ]
description: If `c` is currently a Ritual Monster.
description: >-
`true` if the card is currently a Ritual Monster, `false` otherwise.
status: { index: stable }
tags: [ card-check, card-type-related ]
Loading