Merge pull request #177 from coveooss/coveo-arnparse/doc-fix

docs were reversed 🤦🏻
coveooss · Dec 8, 2023 · 6260745 · 6260745
2 parents 31aca13 + ea8a9e1
commit 6260745
Showing 1 changed file with 12 additions and 12 deletions.
diff --git a/coveo-arnparse/coveo_arnparse/__init__.py b/coveo-arnparse/coveo_arnparse/__init__.py
@@ -41,29 +41,29 @@ class Arn:
     def resource_type(self) -> str:
         """
         Some services provide 2 components in the resource, split on `:` or `/`.
-        Return the suffix, or an empty string otherwise.
+        Return the prefix, or an empty string otherwise.
 
         E.g.:
-         - "arn:aws:ssm:::parameter/some-param-folder/some-param    -> some-param-folder/some-param
-         - "arn:aws:s3:::my-bucket/folder/file.jpg                  -> folder/file.jpg
-         - "arn:aws:cloudwatch:::alarm:some-alarm                   -> some-alarm
-         - "arn:aws:ec2:::vpc/vpc-12345                             -> vpc-12345
-         - 'arn:aws:sns:::my_sns_topic                              -> ""
+         - arn:aws:ssm:::parameter/some-param-folder/some-param    -> parameter
+         - arn:aws:s3:::my-bucket/folder/file.jpg                  -> my-bucket
+         - arn:aws:cloudwatch:::alarm:some-alarm                   -> alarm
+         - arn:aws:ec2:::vpc/vpc-12345                             -> vpc
+         - arn:aws:sns:::my_sns_topic                              -> ""
         """
         return _split_resource_type_and_id(self.resource)[0]
 
     @property
     def resource_id(self) -> str:
         """
         Some services provide 2 components in the resource, split on `:` or `/`.
-        Return the prefix, or an empty string otherwise.
+        Return the suffix, or an empty string otherwise.
 
         E.g.:
-         - arn:aws:ssm:::parameter/some-param-folder/some-param    -> parameter
-         - arn:aws:s3:::my-bucket/folder/file.jpg                  -> my-bucket
-         - arn:aws:cloudwatch:::alarm:some-alarm                   -> alarm
-         - arn:aws:ec2:::vpc/vpc-12345                             -> vpc
-         - arn:aws:sns:::my_sns_topic                              -> ""
+         - "arn:aws:ssm:::parameter/some-param-folder/some-param    -> some-param-folder/some-param
+         - "arn:aws:s3:::my-bucket/folder/file.jpg                  -> folder/file.jpg
+         - "arn:aws:cloudwatch:::alarm:some-alarm                   -> some-alarm
+         - "arn:aws:ec2:::vpc/vpc-12345                             -> vpc-12345
+         - 'arn:aws:sns:::my_sns_topic                              -> ""
         """
         return _split_resource_type_and_id(self.resource)[1]