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

Add option defaults to README. #2030

Closed
rickstaa opened this issue Sep 17, 2022 · 7 comments · Fixed by #2103
Closed

Add option defaults to README. #2030

rickstaa opened this issue Sep 17, 2022 · 7 comments · Fixed by #2103
Assignees
Labels
documentation Improvements or additions to documentation. good first issue Good for newcomers. hacktoberfest help wanted Extra attention is needed.

Comments

@rickstaa
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Currently, we do not list the option defaults in the readme.

Describe the solution you'd like

I think adding the option defaults will improve the documentation. Maybe something like:

- hide_border - Hides the card's border (boolean)
+ hide_border - Hides the card's border (boolean). Defaults to false.
@rickstaa rickstaa added documentation Improvements or additions to documentation. help wanted Extra attention is needed. labels Sep 17, 2022
@asifurrahaman754
Copy link

hi, is this sovled, i would like to work on this

@adi-uchiha
Copy link
Contributor

I want to fix this. any changes to #2051 ?

@Ayushi96
Copy link
Contributor

Ayushi96 commented Oct 2, 2022

Hey @rickstaa, could you please assign this issue to me ?

@rickstaa
Copy link
Collaborator Author

rickstaa commented Oct 2, 2022

@Ayushi96, @adi-uchiha and @asifurrahaman754, @Jagrutiti already fixed several sections from the readme in #2051. The only sections that still need to be done are:

@Ayushi96 I assigned you to this issue since @adi-uchiha and @asifurrahaman754 already have other issues assigned to them. 👍🏻

@Ayushi96
Copy link
Contributor

Ayushi96 commented Oct 2, 2022

Thanks for assigning me the issue @rickstaa
I have created a PR : #2094

@rickstaa
Copy link
Collaborator Author

rickstaa commented Oct 3, 2022

@Ayushi96, I merged your contribution to the master. Thanks!

@adi-uchiha Something went wrong while also trying to merge your PR to the master (see #2092 (comment)). Please create a new PR with the default values that were not yet done by @Ayushi96, and I will include it as a Hacktoberfest contribution.

@rickstaa
Copy link
Collaborator Author

rickstaa commented Oct 4, 2022

@Ayushi96 and @adi-uchiha, thanks again for your contribution! 🔥 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. good first issue Good for newcomers. hacktoberfest help wanted Extra attention is needed.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants