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

Required arguments highlight #30

Closed
pascalduez opened this issue Jul 1, 2014 · 9 comments
Closed

Required arguments highlight #30

pascalduez opened this issue Jul 1, 2014 · 9 comments

Comments

@pascalduez
Copy link
Member

A bit nit-picking here, but could be interesting to have a visual or text information on required arguments (without a default value).
It's already stated whether the argument has a default value or not (at least in comments...).
But that could make it more straightforward I guess.

@KittyGiraudel
Copy link
Member

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

@pascalduez
Copy link
Member Author

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... :)

@KittyGiraudel
Copy link
Member

What do you have in mind?

@pascalduez
Copy link
Member Author

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. ;-)

@KittyGiraudel
Copy link
Member

Alright. Keep me updated :)

@KittyGiraudel
Copy link
Member

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

@pascalduez
Copy link
Member Author

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

@KittyGiraudel
Copy link
Member

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

@KittyGiraudel
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants