AlenkaF commented on code in PR #13564:
URL: https://github.com/apache/arrow/pull/13564#discussion_r917603471


##########
python/pyarrow/_fs.pyx:
##########
@@ -166,19 +186,39 @@ cdef class FileInfo(_Weakrefable):
         Returns
         -------
         type : FileType
+
+        Examples
+        --------
+        >>> local = getfixture('local_fs')

Review Comment:
   The way the fixture for doctest is used here (where you call a fixture with 
`getfixture` method) is the only way I found to optimise the examples. With it 
the code that is repeated in most of the examples gets optimised so that you 
only call a fixture without needing to create a FileSystem object and write 
data into a file.
   
   But, I do think this could be a bit confusing for the user, as we do not 
know what the fixture that is called actually does. If we could just use the 
name `local` in all the examples, that would be much clearer.
   
   Nevertheless I decided to use the fixture and added a comment trying to 
explain in short, what is done when the fixture is called.



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to