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.

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

Code clarity update #492

Merged
merged 6 commits into from
Jul 13, 2024
Merged

Code clarity update #492

merged 6 commits into from
Jul 13, 2024

Commits on Dec 3, 2023

  1. Configuration menu
    Copy the full SHA
    5d973bd View commit details
    Browse the repository at this point in the history

Commits on Apr 12, 2024

  1. Configuration menu
    Copy the full SHA
    78d8370 View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. Configuration menu
    Copy the full SHA
    caddc3d View commit details
    Browse the repository at this point in the history
  2. Removed Deep Source

    rkrishnasanka committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    b24a105 View commit details
    Browse the repository at this point in the history
  3. Updated the basic documentation example

    Improving code clarity
    I'm starting to make some changes to the code documentation here. I'm including a bit of refactoring to make sure that things are more readable.
    
    - The code extensively uses the short variable names to the detriment of the readability. This compounds the problem of not having enough code documentation.
    
    - While golang recommends short variable names, the intention is to avoid long nested function calls and to avoid diverting the attention from the main logic of the program. However, even the main logic variables have really short names making it almost impossible to read.
    
    Incremental renaming of variables in intro.go
    
    First pass of the clarification renaming:
    
    1. Changed all type structs were Pascal Case
    2. Expanded 2-3 character field names for structs
    3. Tried removing redundant functions
    
    Add comments and update function names
    
    Add new comments and function names for better code clarity
    
    Updated go go project files
    
    Undid struct naming that pushed stuff to be public
    
    Undid the public struct scoping
    rkrishnasanka committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    5157f78 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    71d9b08 View commit details
    Browse the repository at this point in the history