Skip to content

Improve API docs#99

Merged
lucassus merged 3 commits intomainfrom
publish
Jul 24, 2025
Merged

Improve API docs#99
lucassus merged 3 commits intomainfrom
publish

Conversation

@lucassus
Copy link
Contributor

This pull request focuses on improving documentation for the API client and its controllers by enhancing clarity and consistency. Key changes include updating import statements in examples, refactoring method signatures for better readability, and standardizing the formatting of type references in the documentation.

Documentation Enhancements:

  • Import Statements in Examples:

    • Added import { Client, Environment } from '@maxio-com/advanced-billing-sdk'; to initialization examples in README.md and doc/client.md for improved clarity. [1] [2]
  • Standardized Type References:

    • Updated type references in response descriptions across multiple files to use backticks (e.g., [Invoice][`Invoice`]) for consistent formatting. This change affects methods in doc/controllers/advance-invoice.md, doc/controllers/api-exports.md, doc/controllers/billing-portal.md, and doc/controllers/component-price-points.md. [1] [2] [3] [4] and others)

Code Example Improvements:

  • Refactored Method Signatures:
    • Refactored method signatures in doc/controllers/api-exports.md and doc/controllers/component-price-points.md to use destructured parameter objects for better readability and scalability. [1] [2] [3] [4]

@lucassus lucassus marked this pull request as ready for review July 24, 2025 13:44
@lucassus lucassus self-assigned this Jul 24, 2025
@lucassus lucassus merged commit 0fe37ca into main Jul 24, 2025
1 check passed
@lucassus lucassus deleted the publish branch July 24, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants