Skip to content
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.

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

Fix incomplete at-docs block #928

Merged
merged 1 commit into from
Jan 29, 2019
Merged

Fix incomplete at-docs block #928

merged 1 commit into from
Jan 29, 2019

Conversation

fredrikekre
Copy link
Member

@fredrikekre fredrikekre commented Jan 23, 2019

Include working doc strings instead of bailing completely in at-docs block.

Fix #799

@fredrikekre fredrikekre requested a review from mortenpi January 23, 2019 15:14
@mortenpi mortenpi changed the title fix #799: incomplete at-docs block Incomplete at-docs block Jan 23, 2019
@mortenpi mortenpi changed the title Incomplete at-docs block Fix incomplete at-docs block Jan 23, 2019
@mortenpi mortenpi added this to the 0.22.0 milestone Jan 24, 2019
@mortenpi
Copy link
Member

Big 👍 to including the docstrings that are possible to include.

However, now there is nothing about the failed ones in the generated output, which I think makes them easy to miss (unless you do strict builds). So I would still output something for the failed docstrings too. Could we maybe just push a generated !!! warn adminition into the doctree? Or maybe keep a list with the DocsNodes and have the writer interpret it?

@fredrikekre
Copy link
Member Author

also fixes #474

@fredrikekre fredrikekre force-pushed the fe/docs-block branch 3 times, most recently from dd823c6 to af55eab Compare January 28, 2019 13:43
@fredrikekre
Copy link
Member Author

Now results in:
screenshot from 2019-01-28 14-45-41

from

```@docs
TestPackage.foo
TestPackage.baz
TestPackage.bar
```

when TestPackage.baz is missing.

Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks awesome!

Have you tested it with all the output formats, to make sure all handle the updated DocsNodes correctly? It might be good to have a test case in test/examples too (although, we might inadvertently already do).

at-docs block fail instead of failing the block completely,
fixes #799 and fixes #474.
@fredrikekre
Copy link
Member Author

Have you tested it with all the output formats, to make sure all handle the updated DocsNodes correctly?

Yes.

It might be good to have a test case in test/examples too (although, we might inadvertently already do).

Exists at the top of https://github.com/JuliaDocs/Documenter.jl/blob/91fc140e7adef2eb17b85d8a2848e805877062ba/test/errors/src/index.md.

@fredrikekre fredrikekre merged commit 1a111e1 into master Jan 29, 2019
@fredrikekre fredrikekre deleted the fe/docs-block branch January 29, 2019 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants