Skip to content

Comments

docs: Export migrate_filenames functions in lib package#19

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-migrate-filenames-exports-2f6432f0dea81e52
Closed

docs: Export migrate_filenames functions in lib package#19
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-migrate-filenames-exports-2f6432f0dea81e52

Conversation

@github-actions
Copy link
Contributor

Summary

Fixes documentation gap where migrate_filenames module functions were documented but not accessible via convenience imports from the lib package.

Changes

  • lib/init.py: Export migrate_all, migrate_file, is_migration_complete, and migration_summary functions
  • docs/library-reference.md: Update Import Cheat Sheet to show both direct module imports and convenience imports from lib

Context

The recent commit b05782a documented the migrate_filenames module in the library reference, but the functions were not added to lib/__init__.py. This meant users could only use:

from lib.migrate_filenames import migrate_all

But not the convenience import pattern documented elsewhere:

from lib import migrate_all

Testing

Verified all documented functions are now importable:

from lib import (
    migrate_all, migrate_file, 
    is_migration_complete, migration_summary
)

All imports succeed, and lib.__all__ now includes these functions.

Documentation Impact

  • Improves API consistency
  • Matches documented behavior
  • Provides ergonomic imports for library users

AI generated by Update Docs

- Add migrate_all, migrate_file, is_migration_complete, migration_summary to lib/__init__.py
- Update library-reference.md to show both direct and convenience import patterns
- Ensures documented API matches actual exports

Fixes documentation gap where migrate_filenames functions were documented
but not accessible via 'from lib import ...' syntax.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Feb 16, 2026
@zircote zircote marked this pull request as ready for review February 18, 2026 01:01
Copilot AI review requested due to automatic review settings February 18, 2026 01:01
@zircote
Copy link
Owner

zircote commented Feb 18, 2026

Closing: PR #21 (aggressive simplification) made these changes obsolete.

@zircote zircote closed this Feb 18, 2026
@zircote zircote deleted the docs/fix-migrate-filenames-exports-2f6432f0dea81e52 branch February 18, 2026 01:02
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR closes an API/documentation gap by making lib.migrate_filenames’s public functions available via from lib import ..., aligning the library’s convenience-import surface with the library reference docs.

Changes:

  • Re-export migrate_filenames helpers (migrate_all, migrate_file, is_migration_complete, migration_summary) from lib/__init__.py and add them to lib.__all__.
  • Update the docs import cheat sheet to show both direct module imports and convenience imports from lib.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
lib/init.py Adds convenience exports + __all__ entries for migration helpers.
docs/library-reference.md Documents convenience-import alternatives in the Import Cheat Sheet.

Comment on lines +7 to +13
# Make paths module easily importable
from .memory_reader import (
get_memory_metadata,
get_memory_summary,
)
from .migrate_filenames import (
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.

The comment # Make paths module easily importable is now misleading since this package __init__ also re-exports memory_reader/migration/search/etc. Consider updating or removing the comment to reflect the broader purpose of these convenience imports.

Copilot uses AI. Check for mistakes.
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant