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 docstrings #236

Closed
s-ankur opened this issue Oct 30, 2018 · 3 comments
Closed

Add docstrings #236

s-ankur opened this issue Oct 30, 2018 · 3 comments
Labels
enhancement New feature or request hacktoberfest-accepted Hacktoberfest! help wanted Extra attention is needed

Comments

@s-ankur
Copy link
Contributor

s-ankur commented Oct 30, 2018

In a lot of these one liners, it is somewhat unclear how we should run these programs. While the respective pull requests have all the documentation we need, it doesnt appear in the actual programs. I think we should add docstrings or comments to all the programs so that it will be clear how one should run them.

@wzhouwzhou
Copy link
Owner

wzhouwzhou commented Oct 30, 2018

I think that’s a good idea, at the very least it would be nice for people to include a link to the PR with instructions
I might make some sort of checklist in the pull request template for this.
Meanwhile, if people want to start opening issues tagging program authors to do so (as opposed to editing someone else's program), that would be nice. Some programs in our repo have great comments as well as tests while others don't, and I think consistency would be nice

@wzhouwzhou wzhouwzhou added this to Reviewing in Hacktoberfest 2018 via automation Oct 30, 2018
@wzhouwzhou wzhouwzhou added enhancement New feature or request help wanted Extra attention is needed hacktoberfest-accepted Hacktoberfest! labels Oct 30, 2018
@wzhouwzhou wzhouwzhou pinned this issue Oct 1, 2019
@Zylatis
Copy link
Contributor

Zylatis commented Nov 1, 2019

This may be overcomplicating things, ironically given the purpose of the repo, but would it be helpful to have class or function templates built for each submission? I'm imagining something similar to say Leetcodes 'solution class' where the user defines one method and all the other stuff is dealt with. Class might be overkill, probably a simple fn is sufficient for most. We could then make a ReadTheDocs for this =D

@wzhouwzhou
Copy link
Owner

@Zylatis That sounds cool, but I'm not too sure how we would implement something like that in an easy and consistent way for anyone to contribute in any language, even if they've never used GitHub before. Do you already have something in mind we can on-board into the repo somehow?

@s-ankur s-ankur closed this as completed Dec 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest-accepted Hacktoberfest! help wanted Extra attention is needed
Projects
No open projects
Hacktoberfest 2018
  
Reviewing
Development

No branches or pull requests

3 participants