[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://cardstories/{python-cardstories.templates}



Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.

>  Choices: nginx
>  _Description: Web server to reconfigure automatically:
>   Please choose the web server that should be automatically configured
> - to run cardstories. If the web server provides http://localhost/, 
> - cardstories can then be played at http://localhost/cardstories/
> + to run cardstories. If the web server provides http://<host_name>/,
> + cardstories can then be played at http://<host_name>/cardstories/.
>  
> I find it confusing to give "localhost" as example, probably best to
> be more generic.    

Yes, I don't see how the game would work if the server was only
accessible as localhost.  Maybe we should use
http://www.example.org/cardstories/?

In the control file:

>  Vcs-Browser: http://cardstori.es/trac/browser
>  Homepage: http://cardstori.es/

There's a "Sources" link that 404s, an interface to play the game
(which doesn't even hint at the rules), and nothing else - I'm not
convinced that's compliant with Policy 5.6.23.  Still, at least the
VCS is there.

>  Package: python-cardstories
>  Section: python

Okay, so it's written in JavaScript and Python... but upstream call it
plain "cardstories".  Python policy says Python develpers don't need
to add a Python prefix unless the Python package contains a Python
module that other Python programs are expected to use (in which case
it should probably be split into a server package and a library
package).  And while I could imagine it going under "Section: web",
the obvious place people will look for it is under "games".

>  Depends: ${misc:Depends},

Doesn't it need a local web server (and prefer nginx)?  Where's the
"nginx | httpd" dependency?

It looks as if I need to send in some bugreports.

> +Description: card guessing game
> 
> Description synopsis should be noun phrase, not a full
> sentence. Moreover, it seems sensible to mention this is a game..:-)

Add some hint that it's web-based, and that it's not solitaire.

   Description: multiplayer online card guessing game

> + This package provides a game where a player (the "author") chooses
> + a card, picks a word or a sentence to describe it
> + and invites other players to guess it.

You've made it less clear that the first player creates the game, and
(apparently) nobody else is involved until they receive invitations to
become players (by email?).  We also ought to mention the server
aspect and make it clear that these aren't standard playing cards (or
even a tarot deck):

    This package provides a server for a networked guessing game using
    picture cards. One player (the "author") creates the game by choosing
    a card, picking a word or a sentence to describe it, and sending out
    invitations to others to participate.

> + .
> + Each player receives seven cards and has to pick
> + one that best matches the author's description.

Make that "Each of these players", because it's not true of player #1.
It would be useful to have a word for all these players other than the
author - "guessers" is the obvious choice.

> + .
>   Once enough players have chosen a card, the author displays all chosen
>   cards and the players try to figure out which one is the author's.

(How many is "enough"?)

> + .
>   The author wins if at least one of the players guesses right, but not all
>   of them do. The winners are the author and the players who guessed right. 
>   If the author loses, all the other players win. 

Probably clearer as two sentences rather than three:

    If at least one but not all of them guesses correctly, the author
    wins, along with the players who guessed correctly. Otherwise, the
    guessers all win.

Or even as one:

    If nobody guesses correctly, or if everyone does, all the guessers
    win; otherwise the winners are the author and the correct guessers.

But maybe that's squeezing too hard.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff -ru python-cardstories.old/control python-cardstories.new/control
--- python-cardstories.old/control	2011-04-27 18:47:47.273258849 +0100
+++ python-cardstories.new/control	2011-05-05 09:51:16.873258726 +0100
@@ -25,14 +25,18 @@
          python-openssl,
          ${python:Depends}
 Provides: ${python:Provides}
-Description: Find out a card using a sentence made up by another player
- A player (who we will call the author) creates a new game. 
- He chooses a card, picks a word or a sentence to describe it
- and invites players to participate.
- Each players is given seven cards and are required to pick
- one that best matches the author's sentence.
+Description: multiplayer online card guessing game
+ This package provides a server for a networked guessing game using
+ picture cards. One player (the "author") creates the game by choosing
+ a card, picking a word or a sentence to describe it, and sending out
+ invitations to others to participate.
+ .
+ Each of these players receives seven cards and has to pick
+ one that best matches the author's description.
+ .
  Once enough players have chosen a card, the author displays all chosen
  cards and the players try to figure out which one is the author's.
- The author wins if at least one of the players guesses right, but not all
- of them do. The winners are the author and the players who guessed right. 
- If the author loses, all the other players win. 
+ .
+ If at least one but not all of them guesses correctly, the author
+ wins, along with the players who guessed correctly. Otherwise, the
+ guessers all win.
diff -ru python-cardstories.old/python-cardstories.templates python-cardstories.new/python-cardstories.templates
--- python-cardstories.old/python-cardstories.templates	2011-04-27 18:47:45.897259016 +0100
+++ python-cardstories.new/python-cardstories.templates	2011-05-05 09:42:53.145258175 +0100
@@ -20,6 +20,5 @@
 Choices: nginx
 _Description: Web server to reconfigure automatically:
  Please choose the web server that should be automatically configured
- to run cardstories. If the web server provides http://localhost/, 
- cardstories can then be played at http://localhost/cardstories/
-
+ to run cardstories. If the web server provides http://www.example.org/,
+ cardstories can then be played at http://www.example.org/cardstories/.
# Copyright (C) 2011 Dachary <loic@dachary.org>
#
# This software's license gives you freedom; you can copy, convey,
# propagate, redistribute and/or modify this program under the terms of
# the GNU Affero General Public License (AGPL) as published by the Free
# Software Foundation (FSF), either version 3 of the License, or (at your
# option) any later version of the AGPL published by the FSF.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero
# General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program in a file in the toplevel directory called
# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.
#
Template: python-cardstories/reconfigure-webserver
Type: multiselect
Choices: nginx
_Description: Web server to reconfigure automatically:
 Please choose the web server that should be automatically configured
 to run cardstories. If the web server provides http://www.example.org/,
 cardstories can then be played at http://www.example.org/cardstories/.
Source: cardstories
Section: python
Priority: optional
Maintainer: Loic Dachary (OuoU) <loic@debian.org>
Build-Depends: debhelper (>= 7.0.50~),
               po-debconf,
               python-all (>= 2.6.6-2~),
               python-coverage,
               python-twisted-web (>= 10.1),
               python-twisted-mail,
               jscoverage
Standards-Version: 3.9.2
Vcs-Git: http://cardstori.es/cardstories.git
Vcs-Browser: http://cardstori.es/trac/browser
Homepage: http://cardstori.es/
X-Python-Version: all

Package: python-cardstories
Section: python
Architecture: all
Depends: ${misc:Depends},
         adduser,
         python-twisted-web (>= 10.1),
         python-twisted-mail,
         python-openssl,
         ${python:Depends}
Provides: ${python:Provides}
Description: multiplayer online card guessing game
 This package provides a server for a networked guessing game using
 picture cards. One player (the "author") creates the game by choosing
 a card, picking a word or a sentence to describe it, and sending out
 invitations to others to participate.
 .
 Each of these players receives seven cards and has to pick
 one that best matches the author's description.
 .
 Once enough players have chosen a card, the author displays all chosen
 cards and the players try to figure out which one is the author's.
 .
 If at least one but not all of them guesses correctly, the author
 wins, along with the players who guessed correctly. Otherwise, the
 guessers all win.

Reply to: