You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "DarthData410 (via GitHub)" <gi...@apache.org> on 2023/04/28 21:05:58 UTC

[GitHub] [iceberg] DarthData410 opened a new pull request, #7467: updates to table/sorting.py comments for mkdocs generation without warnings

DarthData410 opened a new pull request, #7467:
URL: https://github.com/apache/iceberg/pull/7467

   After review with @Fokko the **data (Keyword Args) is where the packed argument representing order_id is expected. Changed the structure of comments to match this fact and mkdocs works fine. Ref: https://mkdocstrings.github.io/griffe/docstrings/#other-parameters issue #7458  


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] Fokko commented on pull request #7467: Python: fix `mkdocs` warnings from `sorting.py`

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#issuecomment-1528115018

   Thanks again @DarthData410 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] Fokko commented on a diff in pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on code in PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#discussion_r1180825476


##########
python/pyiceberg/table/sorting.py:
##########
@@ -115,10 +115,12 @@ class SortOrder(IcebergBaseModel):
     The order of the sort fields within the list defines the order in which the sort is applied to the data.
 
     Args:
+      fields (List[SortField]): The fields how the table is sorted.
+
+    Keyword Args:
       order_id (int): An unique id of the sort-order of a table.
-      fields (List[SortField]): The fields how the table is sorted
     """
-
+    

Review Comment:
   Looks like the linter doesn't agree. Can you add the newline, and remove the spaces. I misread the change.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] DarthData410 commented on a diff in pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "DarthData410 (via GitHub)" <gi...@apache.org>.
DarthData410 commented on code in PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#discussion_r1180822806


##########
python/pyiceberg/table/sorting.py:
##########
@@ -115,10 +115,12 @@ class SortOrder(IcebergBaseModel):
     The order of the sort fields within the list defines the order in which the sort is applied to the data.
 
     Args:
+      fields (List[SortField]): The fields how the table is sorted.
+
+    Keyword Args:
       order_id (int): An unique id of the sort-order of a table.
-      fields (List[SortField]): The fields how the table is sorted
     """
-
+    

Review Comment:
   per request, has bee removed
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] DarthData410 commented on pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "DarthData410 (via GitHub)" <gi...@apache.org>.
DarthData410 commented on PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#issuecomment-1528110389

   never mind... I'm not sure why this was not being removed... I'm using vscode, and it has worked fine. Sorry for the trouble on this, will double check in the future to not cause issues. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] Fokko merged pull request #7467: Python: fix `mkdocs` warnings from `sorting.py`

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko merged PR #7467:
URL: https://github.com/apache/iceberg/pull/7467


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] DarthData410 commented on a diff in pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "DarthData410 (via GitHub)" <gi...@apache.org>.
DarthData410 commented on code in PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#discussion_r1180826583


##########
python/pyiceberg/table/sorting.py:
##########
@@ -115,10 +115,12 @@ class SortOrder(IcebergBaseModel):
     The order of the sort fields within the list defines the order in which the sort is applied to the data.
 
     Args:
+      fields (List[SortField]): The fields how the table is sorted.
+
+    Keyword Args:
       order_id (int): An unique id of the sort-order of a table.
-      fields (List[SortField]): The fields how the table is sorted
     """
-
+    

Review Comment:
   ... done...
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] Fokko commented on pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#issuecomment-1528111640

   @DarthData410 no worries, for some reason, VSCode adds spaces when it isn't needed.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] Fokko commented on a diff in pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on code in PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#discussion_r1180820926


##########
python/pyiceberg/table/sorting.py:
##########
@@ -115,10 +115,12 @@ class SortOrder(IcebergBaseModel):
     The order of the sort fields within the list defines the order in which the sort is applied to the data.
 
     Args:
+      fields (List[SortField]): The fields how the table is sorted.
+
+    Keyword Args:
       order_id (int): An unique id of the sort-order of a table.
-      fields (List[SortField]): The fields how the table is sorted
     """
-
+    

Review Comment:
   Can you remove this newline?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


[GitHub] [iceberg] DarthData410 commented on pull request #7467: updates to table/sorting.py comments for mkdocs generation without warnings

Posted by "DarthData410 (via GitHub)" <gi...@apache.org>.
DarthData410 commented on PR #7467:
URL: https://github.com/apache/iceberg/pull/7467#issuecomment-1528109473

   I'm about to redo this real quick from scratch...


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org