Skip to content

deprecation: Document all deprecated APIs in DEPRECATION.md #214

Description

@kcenon

5W1H Specification

  • Who: Maintainers, downstream system maintainers
  • What: Create comprehensive docs/DEPRECATION.md documenting all deprecated APIs
  • Where: docs/DEPRECATION.md
  • When: Before v3.0.0 release (Phase 1)
  • Why: Provide clear migration path for deprecated APIs
  • How: Document each deprecated API with migration examples

Parent Issue

Part of #213 - Deprecated API Removal Plan for v3.0.0

Scope

Deprecated APIs to Document

  1. logger_interface.h:179-184
    • log(log_level, const std::string&, const std::string& file, int line, const std::string& function)
    • Deprecated in favor of log(log_level, std::string_view, const source_location&)

Deliverables

  • Create docs/DEPRECATION.md with:
    • List of all deprecated APIs
    • Deprecation reason for each API
    • Migration examples (before/after)
    • Target removal version (v3.0.0)
    • Links to related documentation

Acceptance Criteria

  • docs/DEPRECATION.md exists
  • All currently deprecated APIs are documented
  • Migration guides are clear and actionable

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions