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

              relates to

              Task - A task that needs to be done. IGBF-4316 Use index files of VCF for faster loading time

              • Major - Major loss of function.
              • Closed

                Activity

                Ascending order - Click to sort in descending order
                Hide
                Permalink
                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
                Hide
                Permalink
                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

                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
                Hide
                Permalink
                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!
                Hide
                Permalink
                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
                Permalink
                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
                Hide
                Permalink
                pkulzer Paige Kulzer added a comment -

                PR: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1084

                Show
                pkulzer Paige Kulzer added a comment - PR: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1084
                Hide
                Permalink
                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.
                Hide
                Permalink
                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.

                  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: