NSLS2 / NSLS2/pyCHX

imports & params commented out from V1 release - can we delete or not?

Open
#44 0 comments 0 reactions 1 assignee View on GitHub

@ambarb is already working on this.

Since Oct 15, 2020.

_commonspeckle _futurepyCHX question V2
Dominant language
Jupyter Notebook
Stars
8
Forks
12
Avg merge
2h 53m
Merged PRs (30d)
6

Description

This is a place holder to address lines of code that were commented out of V1. Are these lines used as on-the-fly configurations or can they be deleted?

SO far, V2 commented out can be differentiated from V1 commented out because the line will end with #common. For example in v2._commonspeckle.chx_xpcs_xsvs_jupyter_V1:

   1 #from pyCHX.v2._commonspeckle.chx_packages import * #common
   2 from pyCHX.v2._commonspeckle.chx_libs import markers, colors #common #TODO all other instances import with ()
   3 #from pyCHX.chx_generic_functions import get_short_long_labels_from_qval_dict
   4 #RUN_GUI = False
   5 #from pyCHX.chx_libs import markers
   6 import pandas as pds
   7 
  • Lines 3, 4 & 5 were commit and released before V2 began.
    • Seems can delete line 5
    • Don't know about lines 3 & 4
  • Line 1 was commented out after import from V2 was set up.

First, we need to generate a report so someone knowledgeable can review the code. @ambarb will do that below, so assigning to her for now.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.