Comments (8)
Didn't know about this. Will be refactoring the docstrings to conform with PEP 287. reST seems like an obvious choice here.
Thanks for pointing out 😄
from vocabulary.
👍 - it's not a big deal, but it's one of those useful little things that gets overlooked a lot.
from vocabulary.
Fixed in 295ee0b.
Closing issue.
from vocabulary.
:param
and :returns
are great but I also suggest adding :type
and :rtype
fields. That helps A LOT in the long run.
from vocabulary.
An example if you don't mind @balta2ar ? Would surely add it up
from vocabulary.
Something like this:
@defer.inlineCallbacks
def _update_models(self, cur_time,
new_server_stats, max_time_server):
"""
Updates global models and models of budget objects.
@param cur_time: Current time
@type cur_time: datetime.datetime
@param new_server_stats: New server stats
(received since last update).
@type new_server_stats: ProcessedServerStats
@param max_time_server: Timestamp (unix timestamp) of latest
update got from server[s].
@type max_time_server: float
@return: Update models running deferred.
@rtype: defer.Deferred(dict[str, ComputationResult])
"""
from vocabulary.
Yuri, that isn't rst. It would be more like this:
:type param: str
- Expected type of a parameter:rtype: bool
- Type/s of object/s returned by the function
On 4 Dec 2015 15:49, "Tasdik Rahman" [email protected] wrote:
—
Reply to this email directly or view it on GitHub
#6 (comment).
from vocabulary.
@gdude2002 Absolutely, that was just an example of type
/rtype
that I've grabbed from some project.
from vocabulary.
Related Issues (20)
- Blazing fast, but a significant issue HOT 1
- Return False always HOT 1
- [Problems] Inconsistent data HOT 6
- Use nose for finding tests
- docs autogeneration HOT 1
- Initial Update
- Installation issues on Mac HOT 1
- Installation issue on Ubuntu 16.04 HOT 5
- using Antonym gives an error "Connection Lost False" HOT 2
- Ignore Case of Word When Searching Part of Speech
- timeouts HOT 2
- A lot of duplicates from meaning() HOT 3
- usage_example issue HOT 3
- Rate Limit? HOT 1
- Need for automation to release to pypi
- Module not working HOT 1
- Odd requirements.txt HOT 4
- vb.meaning('repudiate') returns false HOT 13
- Contribute more backends, extend API HOT 3
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 vocabulary.