Add @doc false to Inspect.Algebra.no_limit/1 #13893
Merged
Conversation
This file contains hidden or 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
josevalim
reviewed
Oct 10, 2024
lib/elixir/lib/inspect/algebra.ex
Outdated
| doc_cons(doc1, doc2) | ||
| end | ||
|
|
||
| @doc false |
There was a problem hiding this comment.
We should document it, given it is used by external modules. Apologies for missing this earlier.
There was a problem hiding this comment.
I gave it a shot but I'm not very confident 856c9d3, feel free to edit and merge.
sabiwara
force-pushed
the
doc-algebra-no-limit
branch
from
6fdd0b1 to
856c9d3
Compare
josevalim
reviewed
Oct 10, 2024
josevalim
approved these changes
Oct 10, 2024
Co-authored-by: José Valim <[email protected]>
sabiwara
added a commit
that referenced
this pull request
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I noticed this function was public without a doc, should we document it or hide it?
It was added in the context of a formatter bug fix, so probably the latter?