mirror of
https://github.com/stashapp/stash.git
synced 2025-12-15 04:44:28 +01:00
214a15bc40
* Add a space after // comments
For consistency, the commentFormatting lint checker suggests a space
after each // comment block. This commit handles all the spots in
the code where that is needed.
* Rewrite documentation on functions
Use the Go idiom of commenting:
* First sentence declares the purpose.
* First word is the name being declared
The reason this style is preferred is such that grep is able to find
names the user might be interested in. Consider e.g.,
go doc -all pkg/ffmpeg | grep -i transcode
in which case a match will tell you the name of the function you are
interested in.
* Remove old code comment-blocks
There are some commented out old code blocks in the code base. These are
either 3 years old, or 2 years old. By now, I don't think their use is
going to come back any time soon, and Git will track old pieces of
deleted code anyway.
Opt for deletion.
* Reorder imports
Split stdlib imports from non-stdlib imports in files we are touching.
* Use a range over an iteration variable
Probably more go-idiomatic, and the code needed comment-fixing anyway.
* Use time.After rather than rolling our own
The idiom here is common enough that the stdlib contains a function for
it. Use the stdlib function over our own variant.
* Enable the commentFormatting linter
|
||
|---|---|---|
| .. | ||
| urlbuilders | ||
| authentication.go | ||
| changeset_translator.go | ||
| check_version.go | ||
| context_keys.go | ||
| images.go | ||
| locale.go | ||
| resolver.go | ||
| resolver_model_gallery.go | ||
| resolver_model_image.go | ||
| resolver_model_movie.go | ||
| resolver_model_performer.go | ||
| resolver_model_scene.go | ||
| resolver_model_scene_marker.go | ||
| resolver_model_studio.go | ||
| resolver_model_tag.go | ||
| resolver_mutation_configure.go | ||
| resolver_mutation_dlna.go | ||
| resolver_mutation_gallery.go | ||
| resolver_mutation_image.go | ||
| resolver_mutation_job.go | ||
| resolver_mutation_metadata.go | ||
| resolver_mutation_movie.go | ||
| resolver_mutation_performer.go | ||
| resolver_mutation_plugin.go | ||
| resolver_mutation_saved_filter.go | ||
| resolver_mutation_scene.go | ||
| resolver_mutation_scraper.go | ||
| resolver_mutation_stash_box.go | ||
| resolver_mutation_studio.go | ||
| resolver_mutation_tag.go | ||
| resolver_mutation_tag_test.go | ||
| resolver_query_configuration.go | ||
| resolver_query_dlna.go | ||
| resolver_query_find_gallery.go | ||
| resolver_query_find_image.go | ||
| resolver_query_find_movie.go | ||
| resolver_query_find_performer.go | ||
| resolver_query_find_saved_filter.go | ||
| resolver_query_find_scene.go | ||
| resolver_query_find_scene_marker.go | ||
| resolver_query_find_studio.go | ||
| resolver_query_find_tag.go | ||
| resolver_query_job.go | ||
| resolver_query_logs.go | ||
| resolver_query_metadata.go | ||
| resolver_query_plugin.go | ||
| resolver_query_scene.go | ||
| resolver_query_scraper.go | ||
| resolver_subscription_job.go | ||
| resolver_subscription_logging.go | ||
| routes_downloads.go | ||
| routes_image.go | ||
| routes_movie.go | ||
| routes_performer.go | ||
| routes_scene.go | ||
| routes_studio.go | ||
| routes_tag.go | ||
| server.go | ||
| session.go | ||
| types.go | ||