SCCapstone / Delta

A file transfer system for researchers to upload and share data sets with other researchers.
0 stars 0 forks source link

Comment `PrivateRoute.js` from `common` #388

Closed lxaw closed 1 year ago

lxaw commented 1 year ago

Follow a similar pattern to this:

Start of file:

########################
#
# Delta project.
#
# Authors:
# Lexington Whalen (@lxaw)
# Carter Marlowe (@Cmarlowe132)
# Vince Kolb-LugoVince (@vancevince) 
# Blake Seekings (@j-blake-s)
# Naveen Chithan (@nchithan)
#
# File name:
#
# Brief description:

For each function, do something like the following example:

# UTILITY: An example function. Here you would write a bit about what it actually is meant to do / does.
# INPUTS: Here you write about the inputs. Say something about the `dataType` for `arg1` and what `arg1` is.
# OUTPUTS: Here you write about the outputs. Explain what data type is returned, and what it  # means.
def exampleFunction(dataType arg1, ...):
    i = 0 # be sure to comment for confusing variables
    # for any for loops / while loops, may want to explain what you're doing
    while i != 10:
        print("i is {i}") 
        i += 1
    return i #write something about the return value, what it means, what its type is
j-blake-s commented 1 year ago

closed with #418