Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-36131

minor mis-spelling in example documentation of lsst.display.firefly

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: display_firefly
    • Labels:
      None
    • Team:
      External
    • Urgent?:
      No

      Description

      on the page https://pipelines.lsst.io/v/DM-17849/modules/lsst.display.firefly/index.html, there is an example how to set the afw display backend to firefly, which reads:

       

      import lsst.afw.display as afwDisplay 
      afw_display.setDefaultBackend('firefly')
      display1 = afwDisplay.Display(frame=1)
      

       

      on the second line, presumably `afw_display` should be spelled as `afwDisplay`.

       

        Attachments

          Activity

          Hide
          tjenness Tim Jenness added a comment - - edited

          The example looks fine to me: https://pipelines.lsst.io/v/daily/modules/lsst.display.firefly/getting-started-lsp.html

          Not sure why you are using a ticket branch that is from a v17 pipelines release from 2019.

          Show
          tjenness Tim Jenness added a comment - - edited The example looks fine to me: https://pipelines.lsst.io/v/daily/modules/lsst.display.firefly/getting-started-lsp.html Not sure why you are using a ticket branch that is from a v17 pipelines release from 2019.
          Hide
          daniel.weatherill Daniel Weatherill added a comment -

          apologies, 

          it is the first result when googling "lsst display firefly" at least for me.

          Wonder if it's possible to have the doc generator to put a red bar accross the top of the page saying "this isn't the latest/greatest" (a la numpy, scipy, sklearn, skimage etc when you look at an old doc)

          Show
          daniel.weatherill Daniel Weatherill added a comment - apologies,  it is the first result when googling "lsst display firefly" at least for me. Wonder if it's possible to have the doc generator to put a red bar accross the top of the page saying "this isn't the latest/greatest" (a la numpy, scipy, sklearn, skimage etc when you look at an old doc)
          Hide
          tjenness Tim Jenness added a comment -

          Daniel Weatherill in this case I wonder why Google picked that link because it's not even a release version – just a random ticket branch.

          Jonathan Sick Is this sort of "you are reading an old doc" possible? We have the complication that the weeklies are almost always newer than the released version until, of course, a weekly is older than a released version. This is the logic that I implemented in the lsst-versions package but seems excessive here.

          Show
          tjenness Tim Jenness added a comment - Daniel Weatherill in this case I wonder why Google picked that link because it's not even a release version – just a random ticket branch. Jonathan Sick Is this sort of "you are reading an old doc" possible? We have the complication that the weeklies are almost always newer than the released version until, of course, a weekly is older than a released version. This is the logic that I implemented in the lsst-versions package but seems excessive here.
          Hide
          jsick Jonathan Sick added a comment - - edited

          That's a good idea. I'll take that on (note it'll be part of the Sphinx theme + LSST the Docs... it'll probably just be based on viewing any non-main edition (i.e. a /v/ URL prefix).

          Show
          jsick Jonathan Sick added a comment - - edited That's a good idea. I'll take that on (note it'll be part of the Sphinx theme + LSST the Docs... it'll probably just be based on viewing any non-main edition (i.e. a /v/ URL prefix).

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            daniel.weatherill Daniel Weatherill
            Watchers:
            Daniel Weatherill, Jonathan Sick, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.