Coder Social home page Coder Social logo

Comments (6)

mxswd avatar mxswd commented on June 25, 2024

Can these actually error? It sounds like we are just return a Nothing for parts that can't parse. Which is fine.

from documentalist.

jspahrsummers avatar jspahrsummers commented on June 25, 2024

I think we'll eventually want to report errors (in case they're legitimate syntactical issues), though they should probably be considered non-fatal.

from documentalist.

jspahrsummers avatar jspahrsummers commented on June 25, 2024

Eh. Decided that exceptions are okay for what we're doing.

from documentalist.

mxswd avatar mxswd commented on June 25, 2024

Yeah. I agree. I think parseDocs though should change from:
parseDocs :: p -> Package (Maybe Comment) -> Either CommentParseException (Package (Maybe DocBlock))
to:
parseDocs :: p -> Package (Maybe Comment) -> Package (Either CommentParseException DocBlock)
Because a Package or Module or Declaration can't "fail". Only the Maybe Comment.

Making a new PR now.

from documentalist.

mxswd avatar mxswd commented on June 25, 2024

I would be keen on just parseDocs :: p -> Package (Maybe Comment) -> Package (Maybe DocBlock) instead as well.

from documentalist.

mxswd avatar mxswd commented on June 25, 2024

See issue #38

from documentalist.

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.