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

Update developer guide with guidance on namespace aliases

    XMLWordPrintable

    Details

    • Team:
      Data Release Production

      Description

      With the adoption of RFC-34 the developer guide needs to be updated with the new guidance.

      John Swinbank I'm assigning this to team DRP at the moment on the basis that it was triggered by Jim Bosch. We can obviously negotiate.

        Attachments

          Issue Links

            Activity

            Hide
            jbosch Jim Bosch added a comment -

            I have no objection to doing it eventually but I don't see it happening this month.

            Show
            jbosch Jim Bosch added a comment - I have no objection to doing it eventually but I don't see it happening this month.
            Hide
            jsick Jonathan Sick added a comment -

            Implementation-wise, will these be added to the Python and C++ style guides? Or as a new page under "Coding Guides" called something like "Canonical namespace aliases"?

            Show
            jsick Jonathan Sick added a comment - Implementation-wise, will these be added to the Python and C++ style guides? Or as a new page under "Coding Guides" called something like "Canonical namespace aliases"?
            Hide
            tjenness Tim Jenness added a comment -

            Thank you. I'm not asking for it to be done this month, I am tidying up the lose end of the adopted RFC with not ticket attached to it.

            Show
            tjenness Tim Jenness added a comment - Thank you. I'm not asking for it to be done this month, I am tidying up the lose end of the adopted RFC with not ticket attached to it.
            Hide
            tjenness Tim Jenness added a comment -

            I was assuming separate items for python and C++. I'm not overly bothered though.

            Show
            tjenness Tim Jenness added a comment - I was assuming separate items for python and C++. I'm not overly bothered though.
            Hide
            ktl Kian-Tat Lim added a comment -

            Yes, separate text for Python and C++, in the existing style guides, please.

            Show
            ktl Kian-Tat Lim added a comment - Yes, separate text for Python and C++, in the existing style guides, please.
            Hide
            swinbank John Swinbank added a comment -

            RFC-34 was adopted years ago, but this issue has never been important enough to actually act on it. Further, since the RFC, we've written reams of new code which don't follow the (proposed) new standard. At this point, I suggest that we should just abandon this change and withdraw the RFC. Objections?

            Show
            swinbank John Swinbank added a comment - RFC-34 was adopted years ago, but this issue has never been important enough to actually act on it. Further, since the RFC, we've written reams of new code which don't follow the (proposed) new standard. At this point, I suggest that we should just abandon this change and withdraw the RFC. Objections?
            Hide
            jbosch Jim Bosch added a comment - - edited

            Fine with me.  I've been writing pretty much exclusively in the "from <module> import <symbol>" style that's permitted by both the current rules and the proposed ones ever since, and since I've been stuck in daf_butler for a while I haven't had a chance to be annoyed recently by the inconsistent historical alias usage in other packages.

            Show
            jbosch Jim Bosch added a comment - - edited Fine with me.  I've been writing pretty much exclusively in the " from <module> import <symbol> " style that's permitted by both the current rules and the proposed ones ever since, and since I've been stuck in daf_butler for a while I haven't had a chance to be annoyed recently by the inconsistent historical alias usage in other packages.
            Hide
            swinbank John Swinbank added a comment -

            Then I shall mark this as “won't fix” and withdraw the RFC. If anybody disagrees, please shout.

            Show
            swinbank John Swinbank added a comment - Then I shall mark this as “won't fix” and withdraw the RFC. If anybody disagrees, please shout.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              tjenness Tim Jenness
              Watchers:
              Jim Bosch, John Swinbank, Jonathan Sick, Kian-Tat Lim, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.