Make minor doc language fixes in source_url/rel section#2204
Make minor doc language fixes in source_url/rel section#2204DavidOliver merged 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
| 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 |
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. :)
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. :)
There was a problem hiding this comment.
I'll leave the semi-colon in for now and get this merged. Feel free to ping me if you'd prefer it use a full stop.
2 participants
No description provided.