Skip to content
This repository was archived by the owner on Aug 19, 2018. It is now read-only.

Commit 5b94573

Browse files
committed
Docs, close #10 close #15
1 parent c8a0264 commit 5b94573

File tree

4 files changed

+56
-10
lines changed

4 files changed

+56
-10
lines changed

docs/card.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
> **`card_id`** - The ID of the current card.
2121
**Returns:** int
2222

23+
> **`key`** - The key of the current card.
24+
**Returns:** str
25+
2326
> **`elixir`** - The elixir cost of the card.
2427
**Returns:** int
2528

@@ -32,5 +35,8 @@
3235
> **`description`** - The description of the card.
3336
**Returns:** str
3437

35-
> **`decklink`** - The deck link for the card.
38+
> **`deck_link`** - The deck link for the card.
39+
**Returns:** str
40+
41+
> **`image_url`** - An image URL for the card, from cr-api assets.
3642
**Returns:** str

docs/clan.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
?> Represents a clash royale clan.
33

44
#### Attributes
5+
6+
> **`tag`** - The tag of the clan.
7+
**Returns:** str
8+
59
> **`name`** - The name of the clan.
610
**Returns:** str
711

@@ -30,10 +34,19 @@
3034
**Returns:** str
3135

3236
> **`clan_chest`** - The clan's clan chest data
33-
**Returns:** ClanChest
37+
**Returns:** [ClanChest](clanchest.md)
3438

3539
> **`members`** - The clan's members
3640
**Returns:** list [[Member](member.md), [Member](member.md), [Member](member.md)... [Member](member.md)]
3741

3842
> **`badge_url`** - The clan's badge url
39-
**Returns:** str
43+
**Returns:** str
44+
45+
> **`raw_data`** - Raw dictionary data from the API
46+
**Returns:** dict
47+
48+
> **`url`** - API Endpoint for the clan
49+
**Returns:** str
50+
51+
> **`update`** - Update the current object
52+
**Returns:** [Clan](clan.md)

docs/constants.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,22 @@
1414
> **`chest_cycle`** - Information about the full length chest cycle.
1515
**Returns:** list [Silver, Silver, Silver, Gold... Silver]
1616

17-
> **country_codes** - Information about the various countries in the game.
17+
> **`country_codes`** - Information about the various countries in the game.
1818
**Returns:** list [[Country](country.md), [Country](country.md), [Country](country.md)... [Country](country.md)]
1919

20-
> **rarities** - Detailed and technical information about each rarity in the game.
20+
> **`rarities`** - Detailed and technical information about each rarity in the game.
2121
**Returns:** list [[Rarity](rarity.md), [Rarity](rarity.md), [Rarity](rarity.md)... [Rarity](rarity.md)]
2222

23-
> **rarities** - Information about each card in the game.
23+
> **`cards`** - Information about each card in the game.
2424
**Returns:** dict {'knight': [CardInfo](cardinfo.md), 'archers': [CardInfo](cardinfo.md),... 'goblins': [CardInfo](cardinfo.md)]
2525

26+
> **`raw_data`** - Raw dictionary data from the API
27+
**Returns:** dict
28+
29+
> **`url`** - API Endpoint for the profile
30+
**Returns:** str
31+
32+
> **`update`** - Update the current object
33+
**Returns:** [Profile](profile.md)
34+
2635
To get your next chest in cycle, look [here](https://grokkers.github.io/cr-async/#/profile?id=methods)!

docs/profile.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
##### **`get_chest(index=0)`**
1313
* Returns the `index`'th chest of the player.
14-
If player's next chest is `Super Magical`, it returns `Super Magical` when you do `profile.get_clan(0)`
14+
If player's next chest is `Super Magical`, it returns `Super Magical` when you do `profile.get_chest(0)`
1515

1616
* Return Type: str
1717

@@ -25,7 +25,10 @@
2525
> **`level`** - The current level the player is at.
2626
**Returns:** int
2727

28-
> **`experience`** - A tuple of current xp and xp required to level up.
28+
> **`xp`** - A tuple of current xp and xp required to level up. Alias of `experience`
29+
**Returns:** tuple (int, int)
30+
31+
> **`experience`** - A tuple of current xp and xp required to level up. Alias of `xp`
2932
**Returns:** tuple (int, int)
3033

3134
> **`name_changed`** - Indicates whether or not the player has changed names.
@@ -70,6 +73,9 @@
7073
> **`draws`** - The amount of games drawn by the player.
7174
**Returns:** int
7275

76+
> **`three_crown_wins`** - The amount of three crown wins obtained by the player.
77+
**Returns:** int
78+
7379
> **`win_streak`** - The current win streak of the player.
7480
**Returns:** int
7581

@@ -79,7 +85,7 @@
7985
> **`clan_tag`** - The tag of the clan the player is currently in
8086
**Returns:** int or None
8187

82-
> **`clan_tag`** - The name of the clan the player is currently in
88+
> **`clan_name`** - The name of the clan the player is currently in
8389
**Returns:** str or None
8490

8591
> **`clan_role`** - The role of the player in his current clan
@@ -94,8 +100,20 @@
94100
> **`deck`** - The player's deck
95101
**Returns:** list [[Card](card.md), [Card](card.md), [Card](card.md), [Card](card.md), [Card](card.md), [Card](card.md), [Card](card.md), [Card](card.md)]
96102

103+
> **`deck_link`** - A deck link that can be used in the game.
104+
**Returns:** str
105+
97106
> **`clan_badge_url`** - The profile's clan's badge url. Returns None if user is not in a clan.
98107
**Returns:** str or None
99108

100109
> **`seasons`** - Player's previous seasons.
101-
**Returns:** List [[Season](season.md), [Season](season.md), [Season](season.md)... [Season](season.md)] or None
110+
**Returns:** List [[Season](season.md), [Season](season.md), [Season](season.md)... [Season](season.md)] or None
111+
112+
> **`raw_data`** - Raw dictionary data from the API
113+
**Returns:** dict
114+
115+
> **`url`** - API Endpoint for the profile
116+
**Returns:** str
117+
118+
> **`update`** - Update the current object
119+
**Returns:** [Profile](profile.md)

0 commit comments

Comments
 (0)