Skip to content

doc(dottydoc) write out would and remove superfluous word #9569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2020
Merged

doc(dottydoc) write out would and remove superfluous word #9569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/docs/usage/dottydoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ An example structure with an include file "sidebar.html":
Sidebar
=======
Dottydoc gives you the ability to create your own custom table of contents,
this can either be achieved by overriding the `toc.html` include - or by
this can either be achieved by overriding the `toc.html` or by
providing a `sidebar.yml` file in the site root:

```yaml
Expand All @@ -162,7 +162,7 @@ sidebar:

The `sidebar` key is mandatory, as well as `title` for each element. The
default table of contents allows you to have subsections - albeit the current
depth limit is 2 - we'd love to see this change, contributions welcome!
depth limit is 2 -- we would love to see this changed, contributions welcome!

The items which have the `subsection` key, may not have a `url` key in the
current scheme. A site root example with this could be:
Expand Down Expand Up @@ -193,7 +193,7 @@ Linking to members is done in the same fashion:
```

Dottydoc denotes objects by ending their names in "$". To select `Object.range`
you'd therefore write:
you would therefore write:

```markdown
[Object.range](scala.collection.immutable.List$.range)
Expand All @@ -211,7 +211,7 @@ therefore Dottydoc makes it easy to render this inline:
Other extensions
----------------
We would love to have your feedback on what you think would be good in order to
render the documentation you want! Perhaps you'd like to render method
render the documentation you want! Perhaps you would like to render method
definitions or members? Let us know by filing
[issues](https://github.com/lampepfl/dotty/issues/new)!

Expand Down