Skip to content

Commit 8aab4a4

Browse files
docs: fix Account class documentation formatting and examples
Update documentation with proper RST heading underlines and fix Account.edit() code example to include required id parameter.
1 parent 5380bef commit 8aab4a4

4 files changed

Lines changed: 8 additions & 7 deletions

File tree

docs/source/Resources/Account/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -271,9 +271,9 @@ See: `Login to Account <https://api.docs.tago.io/#3196249b-4aef-46ff-b5c3-f103b6
271271
print(login_result) # {'type': 'user', 'id': '...', 'profiles': [...]}
272272
273273
274-
==============
274+
===============
275275
passwordRecover
276-
==============
276+
===============
277277

278278
Send password recovery email to the specified address. This is a static method that doesn't require authentication.
279279

@@ -385,9 +385,9 @@ Confirm account creation using the token sent via email. This is a static method
385385
print(result) # Account confirmed successfully
386386
387387
388-
==================
388+
===================
389389
requestLoginPINCode
390-
==================
390+
===================
391391

392392
Request the PIN Code for a given OTP Type (authenticator, sms, or email). This is a static method that doesn't require authentication.
393393

@@ -472,5 +472,5 @@ Decline a team member invitation to become a profile's team member. This is a st
472472
473473
.. toctree::
474474

475-
Account_Type
475+
Account_type
476476
../../regions

docs/source/Resources/Run/Run_Types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ UserInfo
294294
| **options**: object
295295
| **tags**: list[:ref:`TagsObj`]
296296
297-
.. _LoginResponse:
297+
.. _LoginResponseRunUser:
298298

299299
LoginResponse
300300
-------------

docs/source/Resources/Run/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Log in as a specific user in the TagoRUN service.
154154
155155
**Returns:**
156156

157-
| **result**: :ref:`LoginResponse`
157+
| **result**: :ref:`LoginResponseRunUser`
158158
| Login response.
159159
160160

src/tagoio_sdk/modules/Resources/Account.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ def edit(self, accountObj: Dict) -> str:
5656
```python
5757
resources = Resources()
5858
result = resources.account.edit({
59+
"id": "account-id"
5960
"name": "Updated Account Name",
6061
"timezone": "America/New_York",
6162
"company": "My Company"

0 commit comments

Comments
 (0)