Skip to content

my idea#5261

Closed
Chaitanya-Parab wants to merge 1 commit intoboa-dev:mainfrom
Chaitanya-Parab:feature/auditpublic-api
Closed

my idea#5261
Chaitanya-Parab wants to merge 1 commit intoboa-dev:mainfrom
Chaitanya-Parab:feature/auditpublic-api

Conversation

@Chaitanya-Parab
Copy link
Copy Markdown

This Pull Request fixes/closes #{4524}.

It changes the following:

  • Proposes an approach for auditing and stabilizing Boa’s public API in preparation for the 1.0 release
  • Outlines potential improvements such as:
    • Replacing public struct fields with getter methods to reduce future breaking changes
    • Adding #[non_exhaustive] to enums/structs where extensibility is expected
    • Reviewing visibility (pub vs pub(crate)) to minimize unnecessary API exposure
  • Suggests an incremental, module-by-module approach with small, reviewable PRs

This PR does not introduce code changes but is intended to align on the approach and gather feedback before starting implementation.

Next steps (based on feedback):

  • Identify specific modules for initial API audit
  • Submit small PRs implementing the proposed changes
  • Improve documentation and consistency across public APIs

@Chaitanya-Parab Chaitanya-Parab requested a review from a team as a code owner March 26, 2026 14:25
@github-actions github-actions bot added Waiting On Review Waiting on reviews from the maintainers C-Documentation update documentation and removed Waiting On Review Waiting on reviews from the maintainers labels Mar 26, 2026
@github-actions github-actions bot added this to the v1.0.0 milestone Mar 26, 2026
@jedel1043
Copy link
Copy Markdown
Member

Please open a new discussion instead of pushing docs to the repo.

@jedel1043 jedel1043 closed this Mar 26, 2026
@Chaitanya-Parab
Copy link
Copy Markdown
Author

Chaitanya-Parab commented Mar 27, 2026

Closing this PR as per maintainer feedback. I’ll move this proposal to a discussion instead. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-Documentation update documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants