erius/shad-go
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[docs/gitfame_review_comments.md] Fix typos.

Browse source
This commit is contained in:
Arseny Balobanov 2023-03-15 21:56:13 +03:00
parent 773e39431e
commit 85099147b5
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/gitfame_review_comments.md
View file

@ -8,7 +8,7 @@ NIT пункты (от фразы nit peak) — это мелкие придир
### Парсинг аргументов массивов ### Парсинг аргументов массивов
В решениях частов встречается В решениях часто встречается
```golang ```golang
flagExclude = flag.String("exclude", "", "Globs to exclude") flagExclude = flag.String("exclude", "", "Globs to exclude")
exclude := strings.Split(*flagExclude, ",") exclude := strings.Split(*flagExclude, ",")
@ -94,7 +94,7 @@ import (
### Не нужно класть реализацию непосредственно в internal или pkg ### Не нужно класть реализацию непосредственно в internal или pkg
В месте вызова использование пакета будет выглядет как-то так: В месте вызова использование пакета будет выглядеть как-то так:
```golang ```golang
internal.ListGitFiles(*flagRepository, *flagRevision) internal.ListGitFiles(*flagRepository, *flagRevision)
``` ```
@ -138,7 +138,7 @@ insert `{"author":"X"}` into authors;
где json `{"author":"X"}` вы собираете с помощью `fmt.Sprintf`. где json `{"author":"X"}` вы собираете с помощью `fmt.Sprintf`.
И пользователь передаст вам X, равный `"} into authors; drop authors; "`. И пользователь передаст вам X, равный `"} into authors; drop authors; "`.
тогда он сможет прочитать/затереть приватные данные других пользоватей, потому что выполнится такой запрос тогда он сможет прочитать/затереть приватные данные других пользователей, потому что выполнится такой запрос
``` ```
insert {"author":""} into authors; drop authors; ""}` into authors; insert {"author":""} into authors; drop authors; ""}` into authors;
``` ```
@ -204,7 +204,7 @@ list_files.go
mappingFile, err := os.Open("../../configs/language_extensions.json") mappingFile, err := os.Open("../../configs/language_extensions.json")
``` ```
В таком случае вы не сможете распростанять свою утилиту. В таком случае вы не сможете распространять свою утилиту.
Она будет работать только если рядом лежит json файл. Она будет работать только если рядом лежит json файл.
Утилита должна работать вне зависимости от директории, в которой она была запущена. Утилита должна работать вне зависимости от директории, в которой она была запущена.
@ -221,7 +221,7 @@ var file []byte
Нельзя делать `os.Chdir`. Нельзя делать `os.Chdir`.
После работы утилиты пользователь ожидает, что он останется в той же директории, в которй запускал утилиту. После работы утилиты пользователь ожидает, что он останется в той же директории, в которой запускал утилиту.
Неправильно: Неправильно:
```golang ```golang
@ -285,9 +285,9 @@ for _, file := range files {
} }
``` ```
На большом репозитории одновременно будет зашущено неопределённое количество горутин и подпроцессов. На большом репозитории одновременно будет запущено неопределённое количество горутин и подпроцессов.
Во-первых, каждая горутина требует сколько-то килобайт на стэк и потенциально может закончиться память. Во-первых, каждая горутина требует сколько-то килобайт на стек и потенциально может закончиться память.
Во-вторых, в OS есть ограничение на количество процессов + каждый процесс потребляет сколько-то системных ресурсов (ram, cpu) и суммарное потребление может оказаться неопределённо большим. Во-вторых, в OS есть ограничение на количество процессов + каждый процесс потребляет сколько-то системных ресурсов (ram, cpu) и суммарное потребление может оказаться неопределённо большим.
@ -324,7 +324,7 @@ if err != nil {
При использовании стандартного пакета log в log message добавится время. При использовании стандартного пакета log в log message добавится время.
Возможно, эта информация польователю не очень нужна. Возможно, эта информация пользователю не очень нужна.
Вместо Вместо
```golang ```golang