Skip to content

Adding doctest for md_prefix function in build_directory_md.py #12874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 24, 2025
Merged

Adding doctest for md_prefix function in build_directory_md.py #12874

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89e7bfe
Adding doctests for md_prefix function in build_directory_md.py
diya94 Aug 1, 2025
7c73002
Merge branch 'master' into add-md-prefix-doctest
MaximSmolskiy Aug 24, 2025
155884d
Update build_directory_md.py
MaximSmolskiy Aug 24, 2025
69c92c9
Update build_directory_md.py
MaximSmolskiy Aug 24, 2025
6ffa043
Update build_directory_md.py
MaximSmolskiy Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions scripts/build_directory_md.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,20 @@ def good_file_paths(top_dir: str = ".") -> Iterator[str]:
yield os.path.join(dir_path, filename).lstrip("./")


def md_prefix(i):
return f"{i * ' '}*" if i else "\n##"
def md_prefix(indent: int) -> str:
"""
Markdown prefix based on indent for bullet points

>>> md_prefix(0)
'\\n##'
>>> md_prefix(1)
' *'
>>> md_prefix(2)
' *'
>>> md_prefix(3)
' *'
"""
return f"{indent * ' '}*" if indent else "\n##"


def print_path(old_path: str, new_path: str) -> str:
Expand Down