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

LS-60099 addressing code warnings. #69

Merged
merged 5 commits into from
Mar 27, 2024
Merged

Conversation

adil-sultan
Copy link
Contributor

@adil-sultan adil-sultan commented Mar 25, 2024

What is the current behavior?

Cleaning up some repo warnings to address:
commenting
removing unused parameters host and topoinline
changing a slice declaration to nil
renamed min and max to minimum and maximum to eliminate the collision warnings with builtin functions

What is the new behavior?

Behavior is the same, just cleaned up some warnings


Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests(make test) for the changes have been added (for bug fixes / features) and pass
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Lint (make lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

Does this introduce a breaking change?

  • Yes
  • No

Other information

I was going to update the deprecated rand.Seed usage but after starting this I think it should be it's own PR due to the amount of work it will be. We have LS-60180 for TODO comments.

@adil-sultan adil-sultan requested a review from a team March 25, 2024 21:45
@adil-sultan adil-sultan changed the title LS-60099 addressing goland warnings. LS-60099 addressing code warnings. Mar 25, 2024
1. `$ git clone https://github.com/lightstep/telemetry-generator`
1. `$ cd telemetry-generator`
1. Copy `hipster_shop.yaml` to `dev.yaml` for local development. Not strictly necessary (you can point the `TOPO_FILE` environment variable to any config file) but will potentially save heartache and hassle 😅 This file is in .gitignore, so it won't be included in your commits. If you want to share config changes, add them to a new example config file.
2. `$ git clone https://github.com/lightstep/telemetry-generator`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just so you know, this change probably isn't necessary, lists with all value of 1. should render with actual numbers. But I don't mind the change. It makes the raw markdown text more readable

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL, thank you! I was trying to address all the low hanging fruit code warnings in this PR.

@adil-sultan adil-sultan marked this pull request as ready for review March 27, 2024 17:51
@gdfast gdfast requested a review from a team March 27, 2024 17:59
@adil-sultan adil-sultan merged commit ab5483b into main Mar 27, 2024
3 checks passed
@adil-sultan adil-sultan deleted the LS-60099-address-warnings branch March 27, 2024 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants