Skip to content

Commit 7571856

Browse files
authored
Tweak ExDoc module doc text (#2203)
1 parent fc57bdc commit 7571856

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

lib/ex_doc.ex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ defmodule ExDoc do
463463
464464
### Redirects and changing documentation over time
465465
466-
As your project grows, your documentation may very likely change, even structurally.
466+
As your project grows, your documentation may change, perhaps even structurally.
467467
There are a few important things to consider in this regard:
468468
469469
* Links to your *extras* will break if you change or move file names.
@@ -472,8 +472,8 @@ defmodule ExDoc do
472472
If you change the function name, the link does not break but will leave users
473473
at the top of the module's documentation.
474474
475-
Because these docs are static files, the behavior of a missing page will depend on where they are hosted.
476-
In particular, [hexdocs.pm](https://hexdocs.pm) will show a 404 page.
475+
Because these docs are static files, the behaviour of a missing page will depend on where
476+
they are hosted. In particular, [hexdocs.pm](https://hexdocs.pm) will show a 404 page.
477477
478478
You can improve the developer experience on everything but function names changing
479479
by using the `redirects` configuration. For example, if you changed the module `MyApp.MyModule`
@@ -491,18 +491,18 @@ defmodule ExDoc do
491491
"old-page" => "new-page#relevant-section"
492492
}
493493
494-
### `<meta>`-tags configuration
494+
### Meta tags configuration
495495
496-
It is also possible to configure some of ExDoc behaviour using meta tags.
496+
It is also possible to configure some of ExDoc's behaviour using meta tags.
497497
498-
* `exdoc:autocomplete` - when set to "off", it disables autocompletion.
498+
* `exdoc:autocomplete` - when set to "off", disables autocompletion.
499499
500500
* `exdoc:autocomplete-limit` - Set to an integer to configure how many results
501501
appear in the autocomplete dropdown. Defaults to 10.
502502
503-
You can insert meta tags using `before_closing_head_tag` option.
503+
You can insert meta tags using the `before_closing_head_tag` option.
504504
505-
### `docs_config.js`
505+
### Version dropdown menu
506506
507507
ExDoc will automatically render a version dropdown on HTML pages if a
508508
`docs_config.js` file is placed within the documentation.

0 commit comments

Comments
 (0)