Skip to content

Commit 2c618c6

Browse files
authored
Make "**" literal in glob docstring (#1847)
1 parent 6feca29 commit 2c618c6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

fsspec/spec.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ def glob(self, path, maxdepth=None, **kwargs):
557557
path: str
558558
The glob pattern to match against
559559
maxdepth: int or None
560-
Maximum depth for '**' patterns. Applied on the first '**' found.
560+
Maximum depth for ``'**'`` patterns. Applied on the first ``'**'`` found.
561561
Must be at least 1 if provided.
562562
**kwargs:
563563
Additional arguments passed to ``find`` (e.g., detail=True)
@@ -570,7 +570,7 @@ def glob(self, path, maxdepth=None, **kwargs):
570570
-----
571571
Supported patterns:
572572
- '*': Matches any sequence of characters within a single directory level
573-
- '**': Matches any number of directory levels (must be an entire path component)
573+
- ``'**'``: Matches any number of directory levels (must be an entire path component)
574574
- '?': Matches exactly one character
575575
- '[abc]': Matches any character in the set
576576
- '[a-z]': Matches any character in the range
@@ -584,7 +584,7 @@ def glob(self, path, maxdepth=None, **kwargs):
584584
- Special characters in character classes are escaped properly
585585
586586
Limitations:
587-
- '**' must be a complete path component (e.g., 'a/**/b', not 'a**b')
587+
- ``'**'`` must be a complete path component (e.g., ``'a/**/b'``, not ``'a**b'``)
588588
- No brace expansion ('{a,b}.txt')
589589
- No extended glob patterns ('+(pattern)', '!(pattern)')
590590
"""

0 commit comments

Comments
 (0)