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.

Sign up for GitHub

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

Jump to bottom

Add comments #61

Open
Vild opened this issue Oct 4, 2016 · 5 comments
Open

Add comments #61

Vild opened this issue Oct 4, 2016 · 5 comments
Assignees
@Vild
Labels
effort: moderate The issue will probably take a single contributor one or two days of work to resolve. meta: next release The issue must be resolved before the next package version can be released. priority: medium The issue makes it more difficult for people to use the software. type: code quality The issue involves code organization and readability. type: documentation This issue pertains to the clarity or exhaustiveness of package documentation.
Milestone
Version 0.3

Comments

@Vild
Copy link
Member

Vild commented Oct 4, 2016 •
edited

Add comments to all the code.
This includes comments ion the code where needed and comments for what classes and functions do.

Also add copyright notices, license texts, authors etc. as a header on each source file.

Maybe use https://github.com/MartinNowak/scod for the documentation.
@Vild Vild added this to the Version 0.3 milestone Oct 4, 2016
@Vild Vild self-assigned this Oct 4, 2016
@Vild
Copy link
Member Author

Vild commented Oct 4, 2016

Part of #60

@M4GNV5
Copy link
Member

M4GNV5 commented Oct 4, 2016

Also add copyright notices, license texts, authors etc. as a header on each source file.

ew i never liked that for multi-file stuff but meh

@bytorbrynden
Copy link
Contributor

Also add copyright notices, license texts, authors etc. as a header on each source file.

If only my Visual Studio Code extension wasn't a piece of crap...

@Vild
Copy link
Member Author

Vild commented Oct 4, 2016 •
edited

@M4GNV5, I don't really like it either, but it is good to at least mention the license.
I'll see what I decide in the codestyle document.

@rjmcguire
Copy link

Adding the copyright in each file does help with piece of mind. And forces you to make sure each file is indeed compatible with the overall license.

Also nice to add contributors, like the phobos docs do.

@M4GNV5 M4GNV5 modified the milestones: dconf 2017, Version 0.3 Jan 9, 2017
@Vild Vild modified the milestones: dconf 2017, Version 0.3 Jun 9, 2017
@Vild Vild added effort: moderate The issue will probably take a single contributor one or two days of work to resolve. priority: medium The issue makes it more difficult for people to use the software. type: code quality The issue involves code organization and readability. type: documentation This issue pertains to the clarity or exhaustiveness of package documentation. meta: next release The issue must be resolved before the next package version can be released. and removed enhancement labels Mar 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Vild Vild

Labels
effort: moderate The issue will probably take a single contributor one or two days of work to resolve. meta: next release The issue must be resolved before the next package version can be released. priority: medium The issue makes it more difficult for people to use the software. type: code quality The issue involves code organization and readability. type: documentation This issue pertains to the clarity or exhaustiveness of package documentation.
Projects
None yet
Milestone
Version 0.3
Development

No branches or pull requests
4 participants
@Vild @rjmcguire @bytorbrynden @M4GNV5