Launchpad itself

Merge lp:~matthew.revell/launchpad/bug-heat-help-bug-544799 into lp:launchpad

bug-heat-help-bug-544799
Merge into devel

Proposed by Matthew Revell on 2010-04-23

Status:

Merged

Approved by:

Matthew Revell on 2010-04-28

Approved revision:

no longer in the source branch.

Merged at revision:

not available

Proposed branch:

lp:~matthew.revell/launchpad/bug-heat-help-bug-544799

Merge into:

lp:launchpad

Diff against target:

278 lines (+206/-5)

6 files modified

lib/canonical/launchpad/icing/style-3-0.css.in (+3/-0)
lib/lp/bugs/browser/bugtask.py (+3/-2)
lib/lp/bugs/browser/tests/bug-heat-view.txt (+1/-1)
lib/lp/bugs/help/bug-heat.html (+191/-0)
lib/lp/bugs/scripts/bugheat.py (+4/-1)
lib/lp/bugs/scripts/tests/test_bugheat.py (+4/-1)

To merge this branch:

bzr merge lp:~matthew.revell/launchpad/bug-heat-help-bug-544799

High

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
Eleanor Berger (community)	code	2010-04-23	Approve on 2010-04-26
Michael Nelson (community)	ui	2010-04-23	Approve on 2010-04-23
Canonical Launchpad Engineering		2010-04-23	Pending
Review via email: mp+24016@code.launchpad.net

Commit message

[r=intellectronica][ui=noodles] Adds a pop-up help link to each instance of the bug heat flames icon. It also introduces a new a.help.icon class that removes the underline (actually a border-bottom) where applied, so as not to have an unsightly and distracting underline on the bug heat icon.

Description of the change

This adds a help pop-up to the bug flames, wherever they're displayed.

You can view this here:

https://bugs.launchpad.dev/debian/+source/mozilla-firefox/+bug/3

and here:

https://bugs.launchpad.dev/debian/+source/mozilla-firefox/

It achieves this by adding an "a.help.icon" class to the stylesheet and applying that icon class to the help anchor surrounding the bug heat flames icon.

I've also moved the help pop-up styles from style.css to style-3-0.css.in

Revision history for this message

Michael Nelson (michael.nelson) wrote on 2010-04-23:

Download full text (3.3 KiB)

Thanks Matthew.

{{{
13:55 <mrevell> Something strange happened with my branch; I moved the styles, as you asked, and the underline returned. I moved them back and it's still there, so I've obviously done something without realising it. May I ask what the purpose of the move was?
13:56 <mrevell> Sorry, I'm getting called downstairs
13:56 <mrevell> bbl
13:56 <noodles775> Sure, we're trying to get rid of the old style.css, but we can only do it bit-by-bit, so we're starting with the general styles that we know are still in use.
--- Log closed Fri Apr 23 14:01:31 2010
--- Log opened Fri Apr 23 14:53:56 2010
14:53 -!- mrevellunch is now known as mrevell
14:54 <mrevell> Ah, I see
14:54 <mrevell> I'm gonna see if I can get this working again.
14:54 <noodles775> So that's strange that the underline returned. Did you try inspecting it (have you used firebug or chromium's developer tools? they're great for finding out what style is being applied)
14:55 <mrevell> I didn't use any tools, no. I'll give that a go, thanks. I'm using Chromium so will see what it can offer
14:58 <noodles775> Great, just make sure you've installed the package chromium-browser-inspector and then you should have the option available.
14:58 <mrevell> Aha
--- Log closed Fri Apr 23 15:03:31 2010
--- Log opened Fri Apr 23 15:35:38 2010
15:35 <mrevell> Hey, I've worked out what the problem is (I think). What I mentioned earlier about moving the style from one file to the other was a red herring. This issue seems to be that the default dotted border-bottom is applied to the <a> whereas the border: none is applied to the image, so the image doesn't have border but the anchor does.
15:36 <noodles775> Hrm.. so why was it working (or seemed to be working) earlier?
15:36 <noodles775> But that makes sense.
15:37 <mrevell> All I can think is that I'd not restarted my local instance (and so bugtask.py was still compiled with the inline style).
15:37 <noodles775> Yeah.
15:37 <noodles775> Question:
15:38 <noodles775> I noticed when looking at that branch, that the html generated from the browser *doesn't* include the class attribute (class="help"), where is it added?
15:38 <noodles775> I assume by some js somewhere?
15:38 <noodles775> Anyway, if it does it nicely, you should be able to add class="noborder" to the html generated in the browser code, and then update the style to:
15:39 <noodles775> a.help.noborder {....}
15:39 <mrevell> I believe so.
15:39 <noodles775> (no spaces in that selector).
15:39 <noodles775> Do you want to try that and see if it works?
15:39 <mrevell> Ah, thanks. I'll give that a go. thanks so much for your help
15:39 <noodles775> You can use the inspector to check that both classes are present when the page is generated (ie. it should be class="help noborder" or similar).
15:40 <noodles775> No problems!
--- Log closed Fri Apr 23 15:45:31 2010
--- Log opened Fri Apr 23 15:47:55 2010
15:47 <mrevell> That worked beautifully; thanks.
15:48 <noodles775> Excellent!
15:48 <noodles775> Oh,
15:49 <noodles775> Sorry, I just realised, that class="icon" would actually be more meaningful, rather than "noborder" (which is a presentation thing). Hrm, forget it, that's just too peda...

Thanks Matthew.

{{{
13:55 <mrevell> Something strange happened with my branch; I moved the styles, as you asked, and the underline returned. I moved them back and it's still there, so I've obviously done something without realising it. May I ask what the purpose of the move was?
13:56 <mrevell> Sorry, I'm getting called downstairs
13:56 <mrevell> bbl
13:56 <noodles775> Sure, we're trying to get rid of the old style.css, but we can only do it bit-by-bit, so we're starting with the general styles that we know are still in use.
--- Log closed Fri Apr 23 14:01:31 2010
--- Log opened Fri Apr 23 14:53:56 2010
14:53 -!- mrevellunch is now known as mrevell
14:54 <mrevell> Ah, I see
14:54 <mrevell> I'm gonna see if I can get this working again. 
14:54 <noodles775> So that's strange that the underline returned. Did you try inspecting it (have you used firebug or chromium's developer tools? they're great for finding out what style is being applied)
14:55 <mrevell> I didn't use any tools, no. I'll give that a go, thanks. I'm using Chromium so will see what it can offer
14:58 <noodles775> Great, just make sure you've installed the package chromium-browser-inspector and then you should have the option available.
14:58 <mrevell> Aha
--- Log closed Fri Apr 23 15:03:31 2010
--- Log opened Fri Apr 23 15:35:38 2010
15:35 <mrevell> Hey, I've worked out what the problem is (I think). What I mentioned earlier about moving the style from one file to the other was a red herring. This issue seems to be that the default dotted border-bottom is applied to the <a> whereas the border: none is applied to the image, so the image doesn't have border but the anchor does.
15:36 <noodles775> Hrm.. so why was it working (or seemed to be working) earlier?
15:36 <noodles775> But that makes sense.
15:37 <mrevell> All I can think is that I'd not restarted my local instance (and so bugtask.py was still compiled with the inline style).
15:37 <noodles775> Yeah.
15:37 <noodles775> Question:
15:38 <noodles775> I noticed when looking at that branch, that the html generated from the browser *doesn't* include the class attribute (class="help"), where is it added?
15:38 <noodles775> I assume by some js somewhere?
15:38 <noodles775> Anyway, if it does it nicely, you should be able to add class="noborder" to the html generated in the browser code, and then update the style to:
15:39 <noodles775> a.help.noborder {....}
15:39 <mrevell> I believe so. 
15:39 <noodles775> (no spaces in that selector).
15:39 <noodles775> Do you want to try that and see if it works?
15:39 <mrevell> Ah, thanks. I'll give that a go. thanks so much for your help
15:39 <noodles775> You can use the inspector to check that both classes are present when the page is generated (ie. it should be class="help noborder" or similar).
15:40 <noodles775> No problems!
--- Log closed Fri Apr 23 15:45:31 2010
--- Log opened Fri Apr 23 15:47:55 2010
15:47 <mrevell> That worked beautifully; thanks.
15:48 <noodles775> Excellent!
15:48 <noodles775> Oh,
15:49 <noodles775> Sorry, I just realised, that class="icon" would actually be more meaningful, rather than "noborder" (which is a presentation thing). Hrm, forget it, that's just too pedantic for friday afternoon :)
15:50 <mrevell> No worries, I have to make another commit to shift it back from style.css to style-3-0.css.in
15:50 <noodles775> ah ok, great.
}}}

review: Approve (ui)

Revision history for this message

Eleanor Berger (intellectronica) on 2010-04-26:

review: Approve (code)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Barki Mustapha

Celso Providelo

Christian Reis

Christy Awad

Colin Watson

Harpianto,ANDI

James Troup

John A Meinel

Kevin bush

Launchpad code reviewers

Launchpad code reviewers from Canonical

Matthew Revell

Matthew Tanner

Maximiliano Bertacchini

Oguz Ersoz

Simon Brakhane

Ubuntu-BR DevOps

William Grant

alhawiti

api.ng

pedro cavazos

todaioan

wenjingwen

to status/vote changes:

Tzaddi

Tzaddi Belding

 === modified file 'lib/canonical/launchpad/icing/style-3-0.css.in'
 --- lib/canonical/launchpad/icing/style-3-0.css.in	2010-04-26 22:40:02 +0000
 +++ lib/canonical/launchpad/icing/style-3-0.css.in	2010-04-28 13:34:36 +0000
@@ -233,6 +233,9 @@
  a.help:hover, a.help:hover {
      text-decoration: none;
+     }
++a.help.icon {
++    border: none;
++}
  img, a img {
      /* No border on images that are links. */
      border: none;
 === modified file 'lib/lp/bugs/browser/bugtask.py'
 --- lib/lp/bugs/browser/bugtask.py	2010-04-17 11:58:39 +0000
 +++ lib/lp/bugs/browser/bugtask.py	2010-04-28 13:34:36 +0000
@@ -1121,8 +1121,9 @@
          max_bug_heat = 5000
      heat_ratio = calculate_heat_display(bugtask.bug.heat, max_bug_heat)
      html = (
--        '<span><img src="/@@/bug-heat-%(ratio)i.png" '
--        'alt="%(ratio)i out of 4 heat flames"  title="Heat: %(heat)i" />'
++        '<span><a href="/+help/bug-heat.html" target="help" class="icon"><img'
++        ' src="/@@/bug-heat-%(ratio)i.png" '
++        'alt="%(ratio)i out of 4 heat flames" title="Heat: %(heat)i" /></a>'
          '</span>'
          % {'ratio': heat_ratio, 'heat': bugtask.bug.heat})
      return html
 === modified file 'lib/lp/bugs/browser/tests/bug-heat-view.txt'
 --- lib/lp/bugs/browser/tests/bug-heat-view.txt	2010-03-12 16:55:49 +0000
 +++ lib/lp/bugs/browser/tests/bug-heat-view.txt	2010-04-28 13:34:36 +0000
@@ -12,7 +12,7 @@
      >>> def print_flames(bugtask, target=None):
      ...     html = bugtask_heat_html(bugtask, target=target)
      ...     soup = BeautifulSoup(html)
--    ...     for img in soup.span.contents:
++    ...     for img in soup.span.a.contents:
      ...         print img['src']
      ...         print img['alt']
      ...         print img['title']
 === added file 'lib/lp/bugs/help/bug-heat.html'
 --- lib/lp/bugs/help/bug-heat.html	1970-01-01 00:00:00 +0000
 +++ lib/lp/bugs/help/bug-heat.html	2010-04-28 13:34:36 +0000
@@ -0,0 +1,191 @@
++<html>
++  <head>
++    <title>Bug heat</title>
++    <link rel="stylesheet" type="text/css"
++          href="/+icing/yui/cssreset/reset.css" />
++    <link rel="stylesheet" type="text/css"
++          href="/+icing/yui/cssfonts/fonts.css" />
++    <link rel="stylesheet" type="text/css"
++          href="/+icing/yui/cssbase/base.css" />
++  </head>
++  <body>
++    <h1>Bug heat</h1>
++
++    <p>
++      Launchpad helps you to appraise a bug by giving you a calculated measure
++      &mdash; called bug heat &mdash; of its likely significance.
++    </p>
++
++    <p>
++      You can see bug heat in bug listings, and also on individual bug pages,
++      as four flames: the more flames that are lit, the higher the bug's
++      <em>heat</em>.
++    </p>
++
++    <p>
++      Launchpad works out how many flames to light by calculating a bug heat
++      score and then seeing how that compares with the bug heat of other bugs
++      for that project. If you want to see the bug heat score itself, hover
++      your mouse over the flames icon.
++    </p>
++
++    <p>
++      To calculate the bug heat score, Launchpad looks at the bug's:
++    </p>
++
++    <ul>
++      <li>privacy status</li>
++      <li>security status</li>
++      <li>number of subscribers</li>
++      <li>number of duplicates</li>
++      <li>number of people who've selected the "this bug affects me" option
++      <li>length of time since the last action.</li>
++    </ul>
++
++    <h2>How Launchpad calculates bug heat &mdash; the detailed version</h2>
++
++    <p>
++      Here's exactly how Launchpad calculates the bug heat score. First
++      Launchpad gives the bug a base score:
++    </p>
++
++    <table width="100%">
++      <tr>
++        <th>
++          <strong>Attribute</strong>
++        </th>
++        <th>
++          <strong>Calculation</strong>
++        </th>
++      </tr>
++
++      <tr>
++        <td>
++          Private
++        </td>
++        <td>
++          Adds 150 points
++        </td>
++      </tr>
++
++      <tr>
++        <td>
++          Security issue
++        </td>
++        <td>
++          Adds 250 points
++        </td>
++      </tr>
++
++      <tr>
++        <td>
++          Duplicates
++        </td>
++        <td>
++          Adds 6 points per duplicate bug
++        </td>
++      </tr>
++
++      <tr>
++        <td>
++          Affected users
++        </td>
++        <td>
++          Adds 4 points per affected user
++        </td>
++      </tr>
++
++      <tr>
++        <td>
++          Subscribers (incl. subscribers to duplicates)
++        </td>
++        <td>
++          Adds 2 points per subscriber
++        </td>
++      </tr>
++    </table>
++
++    <p>
++      Next, it adjusts the score depending on how active the bug is:
++    </p>
++
++    <table width="100%">
++      <tr>
++        <th>
++          <strong>Nature of recent activity</strong>
++        </th>
++        <th>
++          <strong>Calculation</strong>
++        </th>
++      </tr>
++
++      <tr>
++        <td>
++          Bug has been active* within the past 24 hours
++        </td>
++        <td>
++          Add 25% of the project's <em>hottest</em> bug's score divided by the
++          number of days since the first activity on the bug in question
++        </td>
++      </tr>
++      <tr>
++        <td>
++          Bug has <strong>not</strong> been active* in within the past 24
++          hours
++        </td>
++        <td>
++          Subtract 1% of the bug heat score for every day of inactivity
++        </td>
++      </tr>
++    </table>
++
++    <p>
++      <small><em>* Activity is either a comment posted or some other update to
++      the bug report.</em></small>
++    </p>
++
++    <p>
++      Some bug statuses will also affect the overall score:
++    </p>
++
++    <table width="100%">
++      <tr>
++        <th>
++          <strong>Status</strong>
++        </th>
++        <th>
++          <strong>Affect on bug heat score</strong>
++        </th>
++      </tr>
++      <tr>
++        <td>
++          Fix Released
++        </td>
++        <td rowspan="4">
++          Reduces the total bug heat score to zero
++        </td>
++      <tr>
++        <td>
++          Invalid
++        </td>
++      </tr>
++      <tr>
++        <td>
++          Won't Fix
++        </td>
++      </tr>
++      <tr>
++        <td>
++          Expired
++        </td>
++      </tr>
++    </table>
++
++    <p>
++      <a target="_blank"
++      href="http://bazaar.launchpad.net/~launchpad-pqm/launchpad/db-devel/annotate/head:/lib/lp/bugs/scripts/bugheat.py">
++      View the Launchpad code that calculates bug heat &gt;</a>.
++    </p>
++
++  </body>
++</html>
 === modified file 'lib/lp/bugs/scripts/bugheat.py'
 --- lib/lp/bugs/scripts/bugheat.py	2010-04-14 12:55:44 +0000
 +++ lib/lp/bugs/scripts/bugheat.py	2010-04-28 13:34:36 +0000
@@ -24,6 +24,10 @@
  class BugHeatCalculator:
      """A class to calculate the heat for a bug."""
++    # If you change the way that bug heat is calculated, remember to update
++    # the description of how it is calculated at
++    # /lib/lp/bugs/help/bug-heat.html and
++    # https://help.launchpad.net/Bugs/BugHeat
      def __init__(self, bug):
          self.bug = bug
@@ -87,4 +91,3 @@
          total_heat = int(total_heat * (0.9 ** months))
          return total_heat
--
 === modified file 'lib/lp/bugs/scripts/tests/test_bugheat.py'
 --- lib/lp/bugs/scripts/tests/test_bugheat.py	2010-04-14 12:55:44 +0000
 +++ lib/lp/bugs/scripts/tests/test_bugheat.py	2010-04-28 13:34:36 +0000
@@ -17,6 +17,10 @@
  class TestBugHeatCalculator(TestCaseWithFactory):
      """Tests for the BugHeatCalculator class."""
++    # If you change the way that bug heat is calculated, remember to update
++    # the description of how it is calculated at
++    # /lib/lp/bugs/help/bug-heat.html and
++    # https://help.launchpad.net/Bugs/BugHeat
      layer = LaunchpadZopelessLayer
@@ -230,4 +234,3 @@
  def test_suite():
      return unittest.TestLoader().loadTestsFromName(__name__)
--