| |
by: Sridhar R |
last post by:
When writing a python library, we can use docstrings for methods and
functions that are part of API. But what about comments for non-API
objects or python application code?
For applications, docstrings are not really much useful. Instead
language comments are prefered for them.
Language comments (starting with #) are usually considered...
|
by: Craig Ringer |
last post by:
Hi folks
I'm currently working on a fairly well internationalised app that embeds
a Python intepreter. I'd like to make the docstrings translatable, but
am running into the issue that the translation function returns unicode
data.
Does anybody here know what encoding docstrings in PyMethodDef are
interpreted as? Is there any sane way to...
|
by: Steven Bethard |
last post by:
I have two classes that implement the same interface, e.g. something like:
class C(object):
def foo(self):
"""Foo things"""
...
def bar(self):
"""Bar things"""
...
def baz(self):
|
by: Kamilche |
last post by:
I have a large project that is getting complex, and I would like to
print the docstrings without importing the modules. The only Python
utility I could find references is apparently defunct and hasn't been
updated in 4 years.
I don't care how spartan the output is - it could look exactly like
python's internal docstrings, for all I care. ...
|
by: Edward Loper |
last post by:
Epydoc 3 supports extracting information about Python modules by
parsing. As a result, it can extract "docstrings" for variables.
There are several possible ways these docstrings could be expressed in
the Python source file, and I wanted to get some feedback on which
ways people prefer. It's my hope that some consensus can be reached
on...
|
| |
by: Darren Dale |
last post by:
I am trying to work with properties, using python 2.4.2. I can't get the
docstrings to work, can someone suggest what I'm doing wrong? I think the
following script should print "This is the doc string.", but instead it
prints:
"float(x) -> floating point number
Convert a string or number to a floating point number, if possible."
Thanks,
|
by: jelle |
last post by:
That's basically the idea...
Often i find myself annotating what variables actually stand for, so to
refer back to the code in half a year or so.
# check if ID's or coords
self.pointIDs = ptIDs
self.coords =
# map ids/coords and coords/ids
self.pointID_2_Coord, self.coord_2_pointID = {}, {}
|
by: Colin J. Williams |
last post by:
Is there some way that the user can access the docstring specified for a
property?
Please see the example below:
# propDocTest
class A(object):
def __init__(self, value):
self.value= value
def vGet(self):
|
by: tjhnson |
last post by:
The topic of docstrings for variables has come up many times before.
In fact, a PEP was proposed and rejected on this very topic.
http://www.python.org/dev/peps/pep-0224/
When creating classes, I like using properties...and I like even more
that these properties have docstrings. This allows one to
interactively explore the API and...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main...
|
by: Hystou |
last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it.
First, let's disable language...
|
| |
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed.
This is as boiled down as I can make it. ...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then...
|
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM).
In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules.
He will explain when you may want to use classes...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert...
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
|
| |
by: bsmnconsultancy |
last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating...
|
