Giter Club home page Giter Club logo

Comments (9)

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

In Sass, required arguments are those who do not have a default value.

from sassdoc.

pascalduez avatar pascalduez commented on May 17, 2024

In Sass, required arguments are those who do not have a default value.

Yes, and they also need to be before any named argument in the signature.

I'm more thinking about some sort of visual differentiation in generated doc.
Just because we can.
(Doesn't mean we should... :)

from sassdoc.

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

What do you have in mind?

from sassdoc.

pascalduez avatar pascalduez commented on May 17, 2024

What do you have in mind?

Maybe a different color, or a small label, or border.

Let me use SassDoc a bit more and generate docs for some of my projects, and it may make sense afterward. ;-)

from sassdoc.

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

Alright. Keep me updated :)

from sassdoc.

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

I'd like to close this any time soon. Hit me up @pascalduez. :)

from sassdoc.

pascalduez avatar pascalduez commented on May 17, 2024

So here are some quick mockups. Actually, I like the idea but wondering if it's all worth.
You judge, you close ;-)
It should ideally make the difference between true required args, and defaults without comments...

1

screen shot 2014-07-03 at 16 49 08

2

screen shot 2014-07-03 at 16 52 51

3

screen shot 2014-07-03 at 16 57 18

from sassdoc.

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

Okay for the *. I'll do that tonight.

from sassdoc.

KittyGiraudel avatar KittyGiraudel commented on May 17, 2024

After thinking about it, I feel like the — in Default value column is enough. If you think otherwise, feel free to open this issue back so we can chat about it.

from sassdoc.

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.