Skip to content

Commit c3ef1cb

Browse files
authored
Update docs.ex
1 parent ba120a6 commit c3ef1cb

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

lib/mix/tasks/docs.ex

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -341,12 +341,14 @@ defmodule Mix.Tasks.Docs do
341341
342342
## Changing documentation over time
343343
344-
As your project grows, your documentation may very likely change, even structurally. There are a few important things to consider in this regard:
345-
346-
- Links to your *extras* will break if you change or move file names.
347-
- Links to your *modules, and mix tasks* will change if you change their name.
348-
- Links to *functions* are actually links to modules with anchor links. If you change the function name, the link does
349-
not break but will leave users at the top of the module's documentation.
344+
As your project grows, your documentation may very likely change, even structurally.
345+
There are a few important things to consider in this regard:
346+
347+
* Links to your *extras* will break if you change or move file names.
348+
* Links to your *modules, and mix tasks* will change if you change their name.
349+
* Links to *functions* are actually links to modules with anchor links.
350+
If you change the function name, the link does not break but will leave users
351+
at the top of the module's documentation.
350352
351353
Because these docs are static files, the behavior of a missing page will depend on where they are hosted.
352354
In particular, [hexdocs.pm](https://hexdocs.pm) will show a 404 page.

0 commit comments

Comments
 (0)