Skip to content

Use static YAMLSpecWriter.sort_keys #93

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
rly merged 3 commits into from
Jun 25, 2025
Merged

Use static YAMLSpecWriter.sort_keys #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
967e7bb
Use static YAMLSpecWriter.sort_keys
rly Jun 25, 2025
0cca28f
Remove _version from source control
rly Jun 25, 2025
e8e70b3
Add _version.py to gitignore
rly Jun 25, 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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,6 @@ docs/_build
# Add Hatch
.hatch/
.venv/

# Hatch-vcs
_version.py
16 changes: 0 additions & 16 deletions hdmf_docutils/_version.py
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions hdmf_docutils/doctools/rst.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,9 @@ def spec_to_yaml(spec):

# Convert to plain dict first
clean_spec = json.loads(json.dumps(spec, indent=4, separators=(',', ': ')))

# Sort keys using YAMLSpecWriter's sort_keys method
hdmf_yaml_writer = YAMLSpecWriter()
sorted_spec = hdmf_yaml_writer.sort_keys(clean_spec)
sorted_spec = YAMLSpecWriter.sort_keys(clean_spec)

yaml = YAML(pure=True)
yaml.default_flow_style = False
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ keywords = [
dependencies = [
"matplotlib",
"networkx",
"hdmf",
"hdmf>=4.1.0",
"pillow",
"sphinx",
"sphinx-gallery",
Expand Down