Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add code documentation and improve readibility of the codebase #3

Open
exoticDFT opened this issue Sep 25, 2020 · 0 comments
Open

Add code documentation and improve readibility of the codebase #3

exoticDFT opened this issue Sep 25, 2020 · 0 comments
Labels
Comp: Documentation Issues related to the documentation of our code Priority: 3 - Normal Moderate priority that may influence functionality or other issues Type: Enhancement Approved issues that will help enhance our AV stack Type: Task Issues that help improve minor parts of the code and not necessarily functionality

Comments

@exoticDFT
Copy link
Member

exoticDFT commented Sep 25, 2020 •
edited
Loading

Some code documentation is missing from some of the codebase. We should update the codebase to include docstyle documentation for each of the nodes. We should also clean up the formatting of the codebase to improve the readibility.

I've been following the NumPy/SciPy docstring style guide for documenting the code and the PEP-8 standard for the code formatting.

Note: This is separate from the general usage documentation. You can install "Flake8" or similar python packages via pip to help make sure the code follows the PEP8 standard.
@exoticDFT exoticDFT added Priority: 3 - Normal Moderate priority that may influence functionality or other issues Type: Enhancement Approved issues that will help enhance our AV stack Type: Task Issues that help improve minor parts of the code and not necessarily functionality Comp: Documentation Issues related to the documentation of our code labels Sep 25, 2020
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issue #3: Cleans up code for the ado vehicle filter
914793b 
- Removes the excess variable creation for colors and moves the values into the ColorRGBA constructor.
- Updates the formatting of the file to match the PEP-8 standard.
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issue #3: Updates the documentation for the controller
973c4aa 
- Adds documentation to the entire controller node.
- Moves some commenting into the summary section of the documentation.
- Adds detail to the function summaries.
- Updates the formatting of the file to match the PEP-8 standard.
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issue #3: Cleans up code
739d1db 
- Removes debugging information that was never meant to be committed.
- Updates some comments.
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issue #3: Cleans up code
d8d12b2 
- Updates the way the ori_circle variable is calculated to simplify the code a bit.
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issues #2 & #3: Adds logging to the controller node
c8f0ee7 
- Replaces some print statements with ROS logging functions.
- Adds several extra ROS debug the info logging functions throughout the node.
- Removes some unnecessary commented code.
exoticDFT added a commit that referenced this issue Sep 25, 2020
@exoticDFT
Issue #3: Improves readability of the map updater code
34e750d 
- Updates some of the formatting of the file to match the PEP-8 standard.
exoticDFT added a commit that referenced this issue Oct 6, 2020
@exoticDFT
Issue #3: Updates some formatting
713f83e 
- Updates some of the formatting in map_updater script to match PEP8 standard.
exoticDFT added a commit that referenced this issue Oct 6, 2020
@exoticDFT
Issue #3: Improves readability of the planner code
7d40f8d 
- Updates some of the formatting of the file to match the PEP-8 standard.
exoticDFT added a commit that referenced this issue Oct 6, 2020
@exoticDFT
Issue #3: Improves readability of the code
dd5ef62 
- Updates some of the formatting of the controller file to match the PEP-8 standard.
- Updates some of the formatting of the planner file to match the PEP-8 standard.
exoticDFT added a commit that referenced this issue Oct 6, 2020
@exoticDFT
Issue #3: Updates the documentation for the controller and map updater
d8aede0 
- Adds docstring comments to each of the functions in the map updater node.
- Updates docstring comments for some of the functions in the controller node.
- Adds docstring comment one of the functions in the controller node.
- Fixes some missing usage of parameters in the controller node.
exoticDFT added a commit that referenced this issue Oct 6, 2020
@exoticDFT
Issue #2 & #3: Updates the visualization nodes
3b6c044 
- Adds docstrings to the classes and functions of the visualization_classespy file.
- Cleans up code by formatting to meet the PEP8 standard.
- Adds some logging information to the main visualization node.
exoticDFT added a commit that referenced this issue Nov 4, 2020
@exoticDFT
Issue #3: Updates README
fd793c2 
- Updates the README to document the way to run the AV stack with the recent additions.
@exoticDFT exoticDFT mentioned this issue Nov 4, 2020
Merged
exoticDFT added a commit that referenced this issue Nov 18, 2020
@exoticDFT
Issue #3 : Updates README
317e9df 
- Updates the README to document the way to run the AV stack with the recent additions.
exoticDFT added a commit that referenced this issue Nov 19, 2020
@exoticDFT
Issue #3: Updates README
3ed6c63 
- Updates the README to remove the instructions for needing the uav_game repo, as this code is no longer used in the AV stack.
- Adds an overview section.
- Modifies some instructions for clarity.
- Adds information about the Michigan server instructions.
exoticDFT added a commit that referenced this issue Nov 19, 2020
@exoticDFT
Issue #3: Updates some formatting
37bc32d 
- Updates the formatting in map_updater and predictor nodes to match PEP 8 standard.
exoticDFT added a commit that referenced this issue Dec 1, 2020
@exoticDFT
Issue #3: Updates formatting
120cf0e 
- Updates the formatting to match PEP8 on the viz_road_network code.
exoticDFT added a commit that referenced this issue Feb 8, 2021
@exoticDFT
Issue #3: Adds some documentation
a3234ae 
- Updates the constants module documentation.
- Adds a license file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Comp: Documentation Issues related to the documentation of our code Priority: 3 - Normal Moderate priority that may influence functionality or other issues Type: Enhancement Approved issues that will help enhance our AV stack Type: Task Issues that help improve minor parts of the code and not necessarily functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@exoticDFT