Improve pathlib.Path.iterdir docstring

Right now it says:

Lines 871 to 876 in e089f23

    
               def iterdir(self): 
        
                   """Iterate over the files in this directory.  Does not yield any 
        
                   result for the special paths '.' and '..'. 
        
                   """ 
        
                   for name in os.listdir(self): 
        
                       yield self._make_child_relpath(name)

This part is confusing:

Does not yield any result for the special paths '.' and '..'

It might be understood as Path('.').iterdir() not yileding any results.

I think, that it would be better to use the exact same wording as in docs: https://docs.python.org/3/library/pathlib.html#pathlib.Path.iterdir

the special entries '.' and '..' are not included.

I will send a PR.

PR: gh-98832: Change wording in docstring of pathlib.Path.iterdir #98833

pythongh-98832: Change wording in `pathlib.Path.iterdir`

gh-98832: Change wording in docstring of `pathlib.Path.iterdir` (GH-9…

@sobolevn

Thanks @sobolevn!

Navigation Menu

Repository navigation

Improve `pathlib.Path.iterdir` docstring #98832

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	def iterdir(self):
	"""Iterate over the files in this directory. Does not yield any
	result for the special paths '.' and '..'.
	"""
	for name in os.listdir(self):
	yield self._make_child_relpath(name)

Improve pathlib.Path.iterdir docstring #98832

Description

Activity

AlexWaygood commented on Nov 9, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

Improve `pathlib.Path.iterdir` docstring #98832