Skip to content

docs: Export migrate_filenames functions in lib package #19

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

Closed
github-actions wants to merge 1 commit into from
Closed

docs: Export migrate_filenames functions in lib package #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/library-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,21 +750,31 @@ def test_memory_operations(test_resolver):
````python
# Paths
from lib.paths import PathResolver, Scope, get_memory_dir
# OR use convenience import
from lib import PathResolver, Scope, get_memory_dir

# Config
from lib.config import get_memory_root

# Memory reading
from lib.memory_reader import get_memory_metadata, get_memory_summary
# OR
from lib import get_memory_metadata, get_memory_summary

# Migration
from lib.migrate_filenames import migrate_all, is_migration_complete
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Migration section, the direct-module import lists only migrate_all and is_migration_complete, but the convenience import lists additional public functions (migrate_file, migration_summary). To avoid confusing users, either include the same set of functions in the direct-module example or explain why the sets differ.

Suggested change
from lib.migrate_filenames import migrate_all, is_migration_complete
from lib.migrate_filenames import migrate_all, migrate_file, is_migration_complete, migration_summary

Copilot uses AI. Check for mistakes.
# OR
from lib import migrate_all, migrate_file, is_migration_complete, migration_summary

# Search
from lib.search import search_memories, find_related_memories_scored
# OR
from lib import search_memories, find_related_memories_scored

# Relationships
from lib.relationships import add_bidirectional_relationship, get_inverse
# OR
from lib import add_bidirectional_relationship, get_inverse

# Ontology
from lib.ontology import load_ontology_data, validate_memory_against_ontology
Expand Down
11 changes: 11 additions & 0 deletions lib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
get_memory_metadata,
get_memory_summary,
)
from .migrate_filenames import (
is_migration_complete,
migrate_all,
migrate_file,
migration_summary,
)
from .ontology import (
get_fallback_content_patterns,
get_fallback_file_patterns,
Expand Down Expand Up @@ -120,6 +126,11 @@
# Memory reader functions
"get_memory_summary",
"get_memory_metadata",
# Migration functions
"migrate_all",
"migrate_file",
"is_migration_complete",
"migration_summary",
# Relationship type registry
"RELATIONSHIP_TYPES",
"RECIPROCAL_TYPES",
Expand Down