docs: update parameter descriptions in License and PILFlavor classes for improved clarity and consistency

Author: bonnie57

src/story_protocol_python_sdk/resources/License.py

@@ -231,7 +231,7 @@ def _register_license_terms_helper(
         """
         Validate the license terms.
 
-        :param license_terms LicenseTermsInput: The license terms.
+        :param license_terms `LicenseTermsInput`: The license terms.
         :param tx_options dict: [Optional] The transaction options.
         :return dict: A dictionary with the transaction hash and the license terms ID.
         """

src/story_protocol_python_sdk/types/resource/License.py

@@ -21,7 +21,7 @@ class LicenseTermsOverride:
         commercial_attribution: Whether commercial attribution is required.
         commercializer_checker: The address of the commercializer checker contract.
         commercializer_checker_data: The data to be passed to the commercializer checker contract.
-        commercial_rev_share: Percentage of revenue that must be shared with the licensor.
+        commercial_rev_share: Percentage of revenue that must be shared with the licensor. Must be between 0 and 100 (where 100% represents 100_000_000).
         commercial_rev_ceiling: The maximum revenue that can be collected from commercial use.
         derivatives_allowed: Whether derivatives are allowed.
         derivatives_attribution: Whether attribution is required for derivatives.

src/story_protocol_python_sdk/utils/pil_flavor.py

@@ -134,8 +134,8 @@ def non_commercial_social_remixing(
 
         See: https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#non-commercial-social-remixing
 
-        :param override: Optional overrides for the default license terms.
-        :return: The license terms dictionary.
+        :param `override` `Optional[LicenseTermsOverride]`: Optional overrides for the default license terms.
+        :return: `LicenseTermsInput`: The license terms.
         """
         terms = _apply_override(PILFlavor._non_commercial_social_remixing_pil, override)
         return PILFlavor.validate_license_terms(terms)
@@ -152,11 +152,11 @@ def commercial_use(
 
         See: https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#commercial-use
 
-        :param default_minting_fee: The fee to be paid when minting a license.
-        :param currency: The ERC20 token to be used to pay the minting fee.
-        :param royalty_policy: The type of royalty policy to be used. Default is LAP.
-        :param override: Optional overrides for the default license terms.
-        :return: The license terms dictionary.
+        :param `default_minting_fee` int: The fee to be paid when minting a license.
+        :param `currency` Address: The ERC20 token to be used to pay the minting fee.
+        :param `royalty_policy` `Optional[RoyaltyPolicyInput]`: The type of royalty policy to be used.(default: LAP)
+        :param `override` `Optional[LicenseTermsOverride]`: Optional overrides for the default license terms.
+        :return: `LicenseTermsInput`: The license terms.
         """
         base = replace(
             PILFlavor._commercial_use,
@@ -180,12 +180,12 @@ def commercial_remix(
 
         See: https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#commercial-remix
 
-        :param default_minting_fee: The fee to be paid when minting a license.
-        :param currency: The ERC20 token to be used to pay the minting fee.
-        :param commercial_rev_share: Percentage of revenue that must be shared with the licensor. Must be between 0 and 100.
-        :param royalty_policy: The type of royalty policy to be used. Default is LAP.
-        :param override: Optional overrides for the default license terms.
-        :return: The license terms dictionary.
+        :param `default_minting_fee` int: The fee to be paid when minting a license.
+        :param `currency` Address: The ERC20 token to be used to pay the minting fee.
+        :param `commercial_rev_share` int: Percentage of revenue that must be shared with the licensor. Must be between 0 and 100.
+        :param `royalty_policy` `Optional[RoyaltyPolicyInput]`: The type of royalty policy to be used.(default: LAP)
+        :param `override` `Optional[LicenseTermsOverride]`: Optional overrides for the default license terms.
+        :return: `LicenseTermsInput`: The license terms.
         """
         base = replace(
             PILFlavor._commercial_remix,
@@ -208,10 +208,10 @@ def creative_commons_attribution(
 
         See: https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#creative-commons-attribution
 
-        :param currency: The ERC20 token to be used to pay the minting fee.
-        :param royalty_policy: The type of royalty policy to be used. Default is LAP.
-        :param override: Optional overrides for the default license terms.
-        :return: The license terms dictionary.
+        :param `currency` Address: The ERC20 token to be used to pay the minting fee.
+        :param `royalty_policy` `Optional[RoyaltyPolicyInput]`: The type of royalty policy to be used.(default: LAP)
+        :param `override` `Optional[LicenseTermsOverride]`: Optional overrides for the default license terms.
+        :return: `LicenseTermsInput`: The license terms.
         """
         base = replace(
             PILFlavor._creative_commons_attribution,
@@ -226,8 +226,8 @@ def validate_license_terms(params: LicenseTermsInput) -> LicenseTermsInput:
         """
         Validates and normalizes license terms.
 
-        :param params: The license terms parameters to validate.
-        :return: The validated and normalized license terms.
+        :param params `LicenseTermsInput`: The license terms parameters to validate.
+        :return: `LicenseTermsInput`: The validated and normalized license terms.
         :raises PILFlavorError: If validation fails.
         """
         # Normalize royalty_policy to address

tests/integration/test_integration_license.py

@@ -336,7 +336,7 @@ def test_set_licensing_config(
                 minting_fee=100,
                 is_set=True,
                 licensing_hook=ZERO_ADDRESS,
-                hook_data=b"",
+                hook_data="test",
                 commercial_rev_share=100,
                 disabled=False,
                 expect_minimum_group_reward_share=10,
@@ -361,7 +361,7 @@ def test_get_licensing_config(
             is_set=True,
             minting_fee=100,
             licensing_hook=ZERO_ADDRESS,
-            hook_data=b"",
+            hook_data=b"test",
             disabled=False,
             expect_minimum_group_reward_share=10 * 10**6,
             expect_group_reward_pool=ZERO_ADDRESS,