Underscore internal methods that are public #2100
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have plenty of internal methods that are not meant to be used externally, often tagged @Private. In a recent office hours, @camertron, @BlakeWilliams and I noted that we should better indicate when an internal method should not be dependended on. I've done so here by adding a `__vc_` prefix as is convention in other parts of the codebase already. As a separate exercise, we should probably re-evaluate our public API surface area and see if we can make any public methods private.
camertron
reviewed
Sep 25, 2024
joelhawksley
force-pushed
the
underscore_private
branch
from
40a40a3 to
ccb9505
Compare
|
@camertron I'm torn. These APIs are not documented publicly, so I'm leaning towards this not being a breaking change. |
|
Yeah I hear you... I worry that we're going against semver by doing this though. Even though the methods in question aren't documented, they're still public, and semver is pretty clear about needing a major bump for API changes. |
|
I could totally see someone using I think hiding the compiler like this makes a ton of sense though. I'd opt for v4, personally. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have plenty of internal methods that are not meant to be used externally, often tagged @Private. In a recent office hours, @camertron, @BlakeWilliams and I noted that we should better indicate when an internal method should not be dependended on. I've done so here by adding a
__vc_prefix as is convention in other parts of the codebase already.As a separate exercise, we should probably re-evaluate our public API surface area and see if we can make any public methods private.