Skip to content

Commit

Permalink
fixed formatting and reworded asset moderation alert docs
Browse files Browse the repository at this point in the history
  • Loading branch information
treeben77 committed Mar 30, 2023
1 parent 0414dc2 commit dcc43a7
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 27 deletions.
21 changes: 11 additions & 10 deletions docs/source/creator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Creator
Uploads an asset onto Roblox.

:param io.BytesIO file: The file opened in bytes to be uploaded.
:param rblx-open-cloud.AssetType: The type of asset you're uploading.
:param str: The name of your asset.
:param str: The description of your asset.
:param rblx-open-cloud.AssetType asset_type: The type of asset you're uploading.
:param str name: The name of your asset.
:param str description: The description of your asset.
:param str expected_robux_price: The amount of robux expected to upload. Fails if lower than actual price.

:returns: Union[:class:`rblx-open-cloud.Asset`, :class:`rblx-open-cloud.PendingAsset`]
:raises rblx-open-cloud.InvalidAsset: The file is not a supported, or is corrupted
Expand All @@ -37,11 +38,11 @@ Creator

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.

Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.
.. note::

Only `Decal`, `Audio`, and `Model` (as `fbx`) are supported right now.
Only ``Decal``, ``Audio``, and ``Model`` (as ``fbx``) are supported right now.

.. method:: update_asset(asset_id, file)

Expand All @@ -59,11 +60,11 @@ Creator

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.
Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.

.. note::

Only `Model` (as `fbx`) can be updated right now.
Only ``Model`` (as ``fbx``) can be updated right now.

.. class:: Asset()

Expand Down Expand Up @@ -143,9 +144,9 @@ Creator

.. versionadded:: 1.1

.. attribute:: Unkown
.. attribute:: Unknown

An unkown asset type (e.g. an unimplemented type)
An unknown asset type (e.g. an unimplemented type)

.. attribute:: Decal

Expand Down
6 changes: 5 additions & 1 deletion docs/source/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,8 @@ Exceptions

The key metadata.

:type: :class:`rblx-open-cloud.EntryInfo`
:type: :class:`rblx-open-cloud.EntryInfo`

.. exception:: InvalidAsset()

The asset you upload is the wrong type, or is corrupted.
17 changes: 9 additions & 8 deletions docs/source/group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ Group
Uploads an asset onto Roblox.

:param io.BytesIO file: The file opened in bytes to be uploaded.
:param rblx-open-cloud.AssetType: The type of asset you're uploading.
:param str: The name of your asset.
:param str: The description of your asset.
:param rblx-open-cloud.AssetType asset_type: The type of asset you're uploading.
:param str name: The name of your asset.
:param str description: The description of your asset.
:param str expected_robux_price: The amount of robux expected to upload. Fails if lower than actual price.

:returns: Union[:class:`rblx-open-cloud.Asset`, :class:`rblx-open-cloud.PendingAsset`]
:raises rblx-open-cloud.InvalidAsset: The file is not a supported, or is corrupted
Expand All @@ -36,11 +37,11 @@ Group

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.

Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.
.. note::

Only `Decal`, `Audio`, and `Model` (as `fbx`) are supported right now.
Only ``Decal``, ``Audio``, and ``Model`` (as ``fbx``) are supported right now.

.. method:: update_asset(asset_id, file)

Expand All @@ -58,8 +59,8 @@ Group

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.
Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.

.. note::

Only `Model` (as `fbx`) can be updated right now.
Only ``Model`` (as ``fbx``) can be updated right now.
17 changes: 9 additions & 8 deletions docs/source/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ User
Uploads an asset onto Roblox.

:param io.BytesIO file: The file opened in bytes to be uploaded.
:param rblx-open-cloud.AssetType: The type of asset you're uploading.
:param str: The name of your asset.
:param str: The description of your asset.
:param rblx-open-cloud.AssetType asset_type: The type of asset you're uploading.
:param str name: The name of your asset.
:param str description: The description of your asset.
:param str expected_robux_price: The amount of robux expected to upload. Fails if lower than actual price.

:returns: Union[:class:`rblx-open-cloud.Asset`, :class:`rblx-open-cloud.PendingAsset`]
:raises rblx-open-cloud.InvalidAsset: The file is not a supported, or is corrupted
Expand All @@ -36,11 +37,11 @@ User

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.

Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.
.. note::

Only `Decal`, `Audio`, and `Model` (as `fbx`) are supported right now.
Only ``Decal``, ``Audio``, and ``Model`` (as ``fbx``) are supported right now.

.. method:: update_asset(asset_id, file)

Expand All @@ -58,8 +59,8 @@ User

.. danger::

Assets are uploaded under your name, and can get your account banned! Be very careful what assets you choose to upload.
Assets uploaded with Open Cloud can still get your account banned if they're inappropriate.

.. note::

Only `Model` (as `fbx`) can be updated right now.
Only ``Model`` (as ``fbx``) can be updated right now.

0 comments on commit dcc43a7

Please sign in to comment.