Updated UIdocumentation.md #497
Conversation
docs/source/UIDocumentation.md
Outdated
| * ```allowDrop``` | ||
| * event | ||
| * ```clickLayerEvent``` - invoked on a click of a layer or on drag of that layer | ||
| * event |
There was a problem hiding this comment.
@Kayo11 can you remove the list of parameters from all description
docs/source/UIDocumentation.md
Outdated
| ```checkIfCuttingLine``` is passed in a positional block that includes x and y coordinates (it assumes a px is at the end of each x and y) for each endpoint of the line it is checking. | ||
| Specifically, it is checking if the line formed with the coordinates in the positional block will cut into any other nodes between them. | ||
|
|
||
| ```checkIfCuttingLine``` creates then creates an equation from the x and y points by calculating the slope and using point slope form. |
|
@Ram81 right on it. |
|
@Ram81 Done, sorry for the grammar mistakes. I hope it's alright now. |
docs/source/UIDocumentation.md
Outdated
| (The bullets contain methods specific to the file along with their explanations.) | ||
|
|
||
| ```addCommentModal.js``` is responsible for adding comments into the interface. It has three methods: | ||
| * ```handleClick``` |
There was a problem hiding this comment.
No explanation for this method? Having no explanation looks a bit weird while all other methods have them. Either move this method to the end of the list, or provide a brief explanation.
docs/source/UIDocumentation.md
Outdated
| * ```dismissError``` - dissmisses the error by ```errorIndex``` | ||
| * ```addError``` - adds error using ```errorText``` | ||
| * ```dismissAllErrors``` - dismisses all errors | ||
| * ```copyTrain``` - copies the nets train option for the test option | ||
| * ```trainOnly``` |
There was a problem hiding this comment.
No explanation for this method? Having no explanation looks a bit weird while all other methods have them. Either move this method to the end of the list, or provide a brief explanation.
docs/source/UIDocumentation.md
Outdated
| *** | ||
| #### ```error.js``` | ||
| ```error.js``` contains Error React Component with two methods: | ||
| * ```dismissError``` |
There was a problem hiding this comment.
No explanation for this method? Having no explanation looks a bit weird while all other methods have them. Either move this method to the end of the list, or provide a brief explanation.
|
@Kayo11 Hello. Neat work! I noticed that some methods do not have explanations. Either move them to the end of the list, or provide a one liner explanation of what they do (recommended). I have marked some in my review. I have may have missed some methods so please check the entire file. |
|
@thatbrguy Yes, you're absolutely right. Thank you for the feedback. I'm on it |
|
@thatbrguy I think I got all of them. Should I change anything else? |
docs/source/UIDocumentation.md
Outdated
|
|
||
| ```canvas.js``` also contains the code that decides whether a node's line needs to be rerouted if it is cutting through another node. | ||
|
|
||
| #### ```canvas.js```'s placement algorithm |
There was a problem hiding this comment.
Can you change this to visualisation algorithm instead of placement algorithm
docs/source/UIDocumentation.md
Outdated
| * ```loadLayerShapes``` - AJAXs to backend to model parameters | ||
| * ```exportNet``` - AJAXs to backend and then passes back error/success | ||
| * framework | ||
| * ```exportPrep``` - invoked by ```exportNet```; prepares for model export |
There was a problem hiding this comment.
use preprocessed model object for export
docs/source/UIDocumentation.md
Outdated
| The method it uses is the following: | ||
| ```checkIfCuttingLine``` is passed in a positional block that includes x and y coordinates (it assumes a px is at the end of each x and y) for each endpoint of the line it is checking. | ||
| Specifically, it is checking if the line formed with the coordinates in the positional block will cut into any other nodes between them. | ||
| * ```changeNetName``` - invoked on the event of net name changed; changes the name of the net |
docs/source/UIDocumentation.md
Outdated
| ```checkIfCuttingLine``` is passed in a positional block that includes x and y coordinates (it assumes a px is at the end of each x and y) for each endpoint of the line it is checking. | ||
| Specifically, it is checking if the line formed with the coordinates in the positional block will cut into any other nodes between them. | ||
| * ```changeNetName``` - invoked on the event of net name changed; changes the name of the net | ||
| * ```changeNetStatus``` - changes boolean for rebuilding. |
docs/source/UIDocumentation.md
Outdated
| Specifically, it is checking if the line formed with the coordinates in the positional block will cut into any other nodes between them. | ||
| * ```changeNetName``` - invoked on the event of net name changed; changes the name of the net | ||
| * ```changeNetStatus``` - changes boolean for rebuilding. | ||
| * ```changeNetPhase``` - changes the phase of the net |
docs/source/UIDocumentation.md
Outdated
| * ```changeNetPhase``` - changes the phase of the net | ||
| * ```dismissError``` - dissmisses the error by ```errorIndex``` | ||
| * ```addError``` - adds error using ```errorText``` | ||
| * ```dismissAllErrors``` - dismisses all errors |
There was a problem hiding this comment.
You can leave some of the obvious methods
docs/source/UIDocumentation.md
Outdated
|
|
||
| The ```getBetween``` also serves the purpose of returning which direction in which the majority of the blocks between are. This is purely for performance, otherwise it would be seperated into a seperate function. | ||
| #### ```field.js``` | ||
| ```field.js``` contains the various different fields used by the layer editor. |
docs/source/UIDocumentation.md
Outdated
| The ```jsplumb.js``` file contains code that handles the arrangement and the dragging/connecting of the layers. A new custom connector is created. There is an if function to check whether the node it is connecting is needing to be routed through an extension. A global variable stores this information, and the actual calculation is handled in ```checkIfCuttingNet``` and ```checkIfCuttingLine```. The global variable contains the amount of pixels it needs to move over, and it will contain direction it needs to go in (based on whether it is positive or | ||
| negative.) | ||
| #### ```importTextbox.js``` | ||
| Renders the textbox for model import from text, using the three frameworks: Caffe, Keras and Tensorflow. |
docs/source/UIDocumentation.md
Outdated
| *** | ||
|
|
||
| #### ```jsplumb.js``` | ||
| The ```jsplumb.js``` file contains code that handles the arrangement and the dragging/connecting of layers. A new custom connector is created. There is an ```if``` function to check whether the node it is connecting to is needs to be routed through an extension. A global variable stores this information, and the actual calculation is handled in ```checkIfCuttingNet``` and ```checkIfCuttingLine```. The global variable contains the amount of pixels it needs to move over, and it will contain direction it needs to go in (based on whether it is positive or negative.) |
There was a problem hiding this comment.
Please rephrase this too, some of the lines are not clear
docs/source/UIDocumentation.md
Outdated
| ### ```tooltip.js``` and ```tooltipData.js``` | ||
|
|
||
| #### ```netLayout_vertical.js``` | ||
| Defines the vertical align of network elements. ```netLayout_vertical.js``` uses a function, called ```allocatePosition``` to give the layers their position on the canvas. It finds the closest position available to the preferred position, and checks if a node is already on that position on the X axis (if one is, a position left or right is assigned). The file also uses a custom Topolical Sort to give the nodes there position (it is based on the inputs and outputs of nodes). Later it is checked if any nodes averlap and in case they do, they are moved. |
|
Now, I changed the code, according to your suggestions, and fixed some other issues. I hope everything is fine after my changes. |
|
@Ram81 @thatbrguy Is there anything else that needs a change? |
docs/source/UIDocumentation.md
Outdated
| #### ```topbar.js``` | ||
| ```topbar.js``` shows the top section of the sidebar. It has two methods: | ||
| * ```checkURL``` - checks model import URL | ||
| * ```render``` - renders the top section of the sidebar |
There was a problem hiding this comment.
@Kayo11 as I said before no need to mention methods for which name of function clearly specifies the function
docs/source/UIDocumentation.md
Outdated
| * ```handleKeyPress``` - handles layer delete after the 'delete' key is pressed | ||
| * ```componentDidMount``` - invokes ```handleKeyPress``` | ||
| * ```componentWillUnmount``` - invokes ```handleKeyPress``` | ||
| * ```render``` - renders layer options sidebar |
There was a problem hiding this comment.
Please describe only methods defined by us, no need to describe standard react methods
|
I deleted the more obvious functions but left out some that need explanation or are unclear and those which are particularly important. |
* Updated UIdocumentation.md * Update UIDocumentation.md * Update UIDocumentation.md * Update UIDocumentation.md * Update UIDocumentation.md * Update UIDocumentation.md
I updated the UIdocumentation.md to include new features and reviewed the previous version.