Comments (7)
AdiChat
commented on May 29, 2024
1
@yashasingh Go for it. 👍
from vidsum.
luisdcb97
commented on May 29, 2024
1
If the function does not explicitly return do we still need to provide a description beyond returns None?
from vidsum.
lwgray
commented on May 29, 2024
1
I think that for the functions that don't return anything, just include a general description of the function and it's inputs. I would exclude the Returns portion of the docstring in these functions. @AdiChat what do you think? Also, don't use Returns None. None is an object in python.
Please chime in if you think it should be handled differently
from vidsum.
lwgray
commented on May 29, 2024
1
Need to reopen issue... I found several minor issues with the docstrings and will submit a PR
from vidsum.
yashasingh
commented on May 29, 2024
@AdiChat I would like to work on this issue.
from vidsum.
AdiChat
commented on May 29, 2024
I agree 👍
from vidsum.
AdiChat
commented on May 29, 2024
Sure 👍
from vidsum.
Related Issues (20)
- Pytube Exception: Multiple videos met this criteria
- Download subtitles of a YouTube video HOT 2
- AUTHORS.md - A file of repo contributors HOT 2
- Commit Template HOT 3
- CONTRIBUTING.md - Instructions on how to contribute to Vidsum HOT 9
- PEP8 Style Guide HOT 2
- Srt file encoding related errors HOT 2
- Summarize a downloaded YouTube video HOT 6
- Wiki needs updating HOT 2
- WindowsError: Can't remove file HOT 4
- Discussion: Video Summary HOT 1
- Issue and Pull request template HOT 1
- Incorrect URL of COMMIT_TEMPLATE in README
- index on pypi HOT 2
- Access is denied
- Is there any reason this is repeated?
- Error on running python sum.py HOT 1
- Proposal to the Repository
- AttributeError: 'NoneType' object has no attribute 'keys' HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from vidsum.