Make minor doc language fixes in source_url/rel section#2204
Open
DavidOliver wants to merge 1 commit intoelixir-lang:mainfrom
Open
Make minor doc language fixes in source_url/rel section#2204DavidOliver wants to merge 1 commit intoelixir-lang:mainfrom
DavidOliver wants to merge 1 commit intoelixir-lang:mainfrom
Conversation
|
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/22228270975/artifacts/5590928132 |
DavidOliver
force-pushed
the
source-url-ref-wording-fixes
branch
from
fa24679 to
349589c
Compare
josevalim
reviewed
Feb 20, 2026
| should run `git tag vVERSION` and push the tag. This way, ExDoc will generate links to the | ||
| specific version the docs were generated for. | ||
| If you use `source_ref: "v#{@version}"`, you should run `git tag vVERSION` and push the tag when | ||
| publishing a new version of your package; ExDoc will generate links to the specific version for |
Member
There was a problem hiding this comment.
I don't think we use ; anywhere in the docs (basically, I don't think I am fluent enough to know when a ; should be used), so I tend to not use it for consistency. :)
Contributor
Author
There was a problem hiding this comment.
No problem - use of them is entirely optional and I can get rid of it if you like.
I like using them as they do help specify relatedness. Like the full stop, the semi-colon begins a new independent clause, but indicates that the latter is closely related to the former. In other words: between a comma and a full stop. :)
josevalim
approved these changes
Feb 20, 2026
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
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.
No description provided.