Re: [RFH] improve the sardana package description
By the way, the Homepage: link seems stale.
PICCA Frederic-Emmanuel wrote:
> Hello, I got a bug report about my package explaining that the short
> description is not meaning full.
The binary package python-sardana... oh, yes, it's not exactly easy to
guess the context from the synopsis "sardana control system"; it
sounds as if it's software for controlling sardanas.
> so I contacted the upstream to decide of a new short and long description.
>
> I attache the current control file and here the new starting point
> proposed by the upstream.
>
> Short:
>
> Sardana is a Python-based SCADA for scientific installations
It doesn't need to be a sentence. The first half of this is just
unpacking the package name, which is mostly a waste of space; and if
I'm scanning Section: python and wondering whether this package would
be useful to me, I'm unlikely to happen to know what SCADA means
(though at least "for scientific installations" gives some hint at the
context.)
The best solution I can find that will fit on one line is:
instrument control and data acquisition system
and then there's room to add:
- library
- documentation
> Long:
(The old long-description did have the advantage of including the word
"Synchrotron" for extra context.)
> Sardana is a software package for Supervision, Control and Data
Well, obviously it's a software package!
That should be a capital "A" for "And".
> Acquisition (SCADA) optimized for scientific installations. It is
It seems to me that being "optimized for scientific installations" is
part of the definition of a SCADA rather than a description of this
one. I would suggest shortening this to:
Sardana is a Supervision, Control and Data Acquisition (SCADA) system for
scientific installations.
> written in Python and based in the Tango library. The hardware control
"Based on", and isn't it TANGO (or maybe PyTango)?
> and data acquisition routines can be accessed via an IPython console
> and a generic graphical user interface (both of which are easily
> extensible by the user).
This part's all good.
(ObWhyTheName: following on from TANGO, a sardana is a Catalan dance.)
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Source: sardana
Maintainer: Debian Science Maintainers <debian-science-maintainers@lists.alioth.debian.org>
Uploaders: Picca Frédéric-Emmanuel <picca@debian.org>
Section: science
Priority: extra
Build-Depends: debhelper (>= 9),
graphviz,
python-all,
python-lxml,
python-pytango (>= 8.0.3-2),
python-sphinx,
python-taurus (>= 3.1.0),
rdfind,
symlinks
Standards-Version: 3.9.4
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=debian-science/packages/sardana.git
Vcs-Git: git://anonscm.debian.org/debian-science/packages/sardana.git
Homepage: http://www.tango-controls.org/static/Sardana/latest/doc/html/
X-Python-Version: >= 2.6
Package: python-sardana
Architecture: all
Section: python
Depends: ${misc:Depends},
${python:Depends},
python-lxml,
python-nxs,
python-pytango (>= 8.0.3-2),
python-taurus (>= 3.1.0)
Provides: ${python:Provides}
Description: instrument control and data acquisition system - library
Sardana is a Supervision, Control And Data Acquisition (SCADA) system for
scientific installations. It is written in Python and based on the TANGO
library. The hardware control and data acquisition routines can be
accessed via an IPython console and a generic graphical user interface
(both of which are easily extensible by the user).
Package: python-sardana-doc
Architecture: all
Section: doc
Depends: ${misc:Depends},
${sphinxdoc:Depends}
Description: instrument control and data acquisition system - documentation
Sardana is a Supervision, Control And Data Acquisition (SCADA) system for
scientific installations. It is written in Python and based on the TANGO
library. The hardware control and data acquisition routines can be
accessed via an IPython console and a generic graphical user interface
(both of which are easily extensible by the user).
.
This package contains the documentation for the python-sardana library.
--- control.pristine 2014-01-28 20:36:27.203246682 +0000
+++ control 2014-01-28 21:31:35.717102075 +0000
@@ -28,26 +28,23 @@
python-pytango (>= 8.0.3-2),
python-taurus (>= 3.1.0)
Provides: ${python:Provides}
-Description: sardana control system
- SARDANA, is a TANGO based control system designed for instrument
- control and data acquisition, mainly developed by CELLS Alba
- Synchrotron Controls Section. SARDANA framework is designed to hide
- the complexity and heterogeneity of the control system (some internal
- control of a group of devices), while providing a wide, rich, and
- extensible set of operations that a user may need.
+Description: instrument control and data acquisition system - library
+ Sardana is a Supervision, Control And Data Acquisition (SCADA) system for
+ scientific installations. It is written in Python and based on the TANGO
+ library. The hardware control and data acquisition routines can be
+ accessed via an IPython console and a generic graphical user interface
+ (both of which are easily extensible by the user).
Package: python-sardana-doc
Architecture: all
Section: doc
Depends: ${misc:Depends},
${sphinxdoc:Depends}
-Description: sardana control system
- SARDANA, is a TANGO based control system designed for instrument
- control and data acquisition, mainly developed by CELLS Alba
- Synchrotron Controls Section. SARDANA framework is designed to hide
- the complexity and heterogeneity of the control system (some internal
- control of a group of devices), while providing a wide, rich, and
- extensible set of operations that a user may need.
+Description: instrument control and data acquisition system - documentation
+ Sardana is a Supervision, Control And Data Acquisition (SCADA) system for
+ scientific installations. It is written in Python and based on the TANGO
+ library. The hardware control and data acquisition routines can be
+ accessed via an IPython console and a generic graphical user interface
+ (both of which are easily extensible by the user).
.
This package contains the documentation for the python-sardana library.
-
Reply to: