Giter VIP home page Giter VIP logo

Comments (7)

rlefevre avatar rlefevre commented on June 9, 2024

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.

jxxcarlson avatar jxxcarlson commented on June 9, 2024

from elm-doc-preview.

rlefevre avatar rlefevre commented on June 9, 2024

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.

rlefevre avatar rlefevre commented on June 9, 2024

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.

jxxcarlson avatar jxxcarlson commented on June 9, 2024

from elm-doc-preview.

rlefevre avatar rlefevre commented on June 9, 2024

It should be at the same place as the elm-application.json, so in app sub-directory.

from elm-doc-preview.

jxxcarlson avatar jxxcarlson commented on June 9, 2024

from elm-doc-preview.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.