Comments (7)
Error should be displayed in the browser, but in case they are not, could you try running last version (5.0.5) with -o docs.json
option? This should display errors in the terminal.
from elm-doc-preview.
from elm-doc-preview.
With --debug
(or -d
) option, the build directory is kept (here /Users/carlson/dev/brilliant/minilatex-b
), so you can go inside and
run elm make --docs=docs.json
manually to see the error.
Here, you problem is:
-- DOCS MISTAKE --------------------------------- src/Compiler/GenericDiffer.elm
I do not see `diff` in your module documentation, but it is in your `exposing`
list:
1| module Compiler.GenericDiffer exposing (DiffRecord, diff)
^^^^
Add a line like `@docs diff` to your module documentation!
Note: See <https://elm-lang.org/0.19.1/docs> for more guidance on writing high
quality docs.
I will check why the error is not displayed by elm-doc-preview.
from elm-doc-preview.
The error is not displayed by elm-doc-preview in the browser because you are missing a README.md
.
Just add at least an empty README.md
and you should see the errors.
This is not the expected behavior though, the error should be displayed even without a README.
from elm-doc-preview.
from elm-doc-preview.
It should be at the same place as the elm-application.json
, so in app
sub-directory.
from elm-doc-preview.
from elm-doc-preview.
Related Issues (20)
- Add an option to check whether the documentation is correct HOT 2
- Maintain scroll position when hot reloading? HOT 4
- Error: ENOENT: no such file or directory, mkdir ... when building application doc
- The doc server can't find `elm.json` in some folder structures HOT 1
- `npm audit` warns about vulnerabilites HOT 3
- works nicely HOT 3
- Feature request: Generate docs.json, then exit HOT 1
- Add a CLI option to check whether application documentation is correct HOT 5
- Doc server quits with error below after 10-30 seconds. HOT 4
- elm-doc-preview can get confused if multiple files are modified simultaneously HOT 1
- npm complains about peer dependencies HOT 8
- Provide a way to expose all modules in an application HOT 8
- A better default for the application name HOT 3
- Online version should mention that this works also for applications
- elm-doc-preview crashes after 30 seconds HOT 4
- Static site generation HOT 5
- No output seen when doc format is missing/has errors
- Handle documentation for unexposed code
- Configurable binding address with loopback as default
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from elm-doc-preview.