Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-4331

Replace instances of "Console" with "Log" in IGB codebase

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 10.2.0
    • Labels:
      None

      Description

      Situation: As part of testing IGBF-4316, I noticed that an error message being thrown referenced the Log as "Console". This is old terminology that IGB no longer uses.

      Task: Look through the IGB codebase for all user-facing instances of the term Console and replace them with Log. I (Paige) will also look for instances in the User's Guide and make updates accordingly.

        Attachments

          Issue Links

            Activity

            pkulzer Paige Kulzer created issue -
            pkulzer Paige Kulzer made changes -
            Field Original Value New Value
            Epic Link IGBF-1765 [ 17855 ]
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-4316 [ IGBF-4316 ]
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            I've updated the following page in the User's Guide:
            "Showing the Console" -> "Showing the Log" - https://wiki.bioviz.org/confluence/display/igbman/Showing+the+Log

            Show
            pkulzer Paige Kulzer added a comment - - edited I've updated the following page in the User's Guide: "Showing the Console" -> "Showing the Log" - https://wiki.bioviz.org/confluence/display/igbman/Showing+the+Log
            ann.loraine Ann Loraine made changes -
            Sprint Fall 4 [ 227 ] Fall 4, Fall 5 [ 227, 228 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Sprint Fall 4, Fall 5 [ 227, 228 ] Fall 4, Fall 5, Fall 6 [ 227, 228, 229 ]
            nfreese Nowlan Freese made changes -
            Rank Ranked higher
            pkulzer Paige Kulzer made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ]
            Show
            pkulzer Paige Kulzer added a comment - Branch: https://bitbucket.org/pkulzer-lorainelab/integrated-genome-browser/branch/IGBF-4331?dest=pkulzer-lorainelab%2Fintegrated-genome-browser%3Amain
            pkulzer Paige Kulzer made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ] Nowlan Freese [ nfreese ]
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            As suggested, I've updated my commit to only replace instances of "Console" in user-facing instances such as error messages.

            Ready for review!

            Show
            pkulzer Paige Kulzer added a comment - - edited As suggested, I've updated my commit to only replace instances of "Console" in user-facing instances such as error messages. Ready for review!
            ann.loraine Ann Loraine made changes -
            Sprint Fall 4, Fall 5, Fall 6 [ 227, 228, 229 ] Fall 4, Fall 5, Fall 6, Fall 7 [ 227, 228, 229, 230 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            Hide
            pkulzer Paige Kulzer added a comment -

            In the SAM.java file some of the error messages say "Select Help > Show Log" versus "See Log". We've opted to use this for all related error messages since it's more informative. I've gone ahead and made that change, as well as reversed some changes to developer-facing error messages.

            Show
            pkulzer Paige Kulzer added a comment - In the SAM.java file some of the error messages say "Select Help > Show Log" versus "See Log". We've opted to use this for all related error messages since it's more informative. I've gone ahead and made that change, as well as reversed some changes to developer-facing error messages.
            Hide
            nfreese Nowlan Freese added a comment -

            Code changes look good. Tested with a broken vcf file (I took a regular VCF and replaced the header line with a bunch of random characters) and was able to see the corrected error message.

            Ready for PR

            Show
            nfreese Nowlan Freese added a comment - Code changes look good. Tested with a broken vcf file (I took a regular VCF and replaced the header line with a bunch of random characters) and was able to see the corrected error message. Ready for PR
            nfreese Nowlan Freese made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ] Paige Kulzer [ pkulzer ]
            Show
            pkulzer Paige Kulzer added a comment - PR: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1084
            pkulzer Paige Kulzer made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ] Ann Loraine [ aloraine ]
            ann.loraine Ann Loraine made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            PR is merged into main and new installers are built and deployed to early access section of bioviz.org.

            Ready for testing.

            Show
            ann.loraine Ann Loraine added a comment - - edited PR is merged into main and new installers are built and deployed to early access section of bioviz.org. Ready for testing.
            nfreese Nowlan Freese made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            nfreese Nowlan Freese made changes -
            Assignee Ann Loraine [ aloraine ]
            nfreese Nowlan Freese made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            Hide
            nfreese Nowlan Freese added a comment -

            Tested on Mac using early access installer. Log is now referred to in the error.

            Closing ticket.

            Show
            nfreese Nowlan Freese added a comment - Tested on Mac using early access installer. Log is now referred to in the error. Closing ticket.
            nfreese Nowlan Freese made changes -
            Assignee Paige Kulzer [ pkulzer ]
            nfreese Nowlan Freese made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            pkulzer Paige Kulzer made changes -
            Fix Version/s 10.2.0 [ 11100 ]

              People

              • Assignee:
                pkulzer Paige Kulzer
                Reporter:
                pkulzer Paige Kulzer
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: