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

fix readme #378

Merged
merged 8 commits into from
Aug 5, 2024
Merged

fix readme #378

merged 8 commits into from
Aug 5, 2024

Conversation

slavaleleka
Copy link
Contributor

No description provided.

@@ -139,7 +158,7 @@ Add tracker domains to the **trackerDomains** section:
| 13 | email | Includes webmail and email clients |
| 14 | consent | - |
| 15 | telemetry | - |
| 16 | mobile_analytics | Collects and analyzes data related to mobile app usage and performance |
| 101 | mobile_analytics | Collects and analyzes data related to mobile app usage and performance |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@slavaleleka slavaleleka requested a review from jellizaveta August 1, 2024 16:21
- [dist/trackers.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/dist/trackers.json) - contains information about trackers, obtained by merging the [source/trackers.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/source/trackers.json) with [source/whotracksme.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/dist/whotracksme.json).
- [source/whotracksme.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/source/whotracksme.json) - contains information about trackers, fetched from whotracks.me.
- [source/trackers.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/source/trackers.json) - contains information about trackers, which overwrites or supplements [dist/whotracksme.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/dist/whotracksme.json).
- [dist/whotracksme.json] — just a copy of [source/whotracksme.json].
Copy link
Member

Choose a reason for hiding this comment

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

зачем длинные тире? Это ж не роман.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

тире не только в романах используется

Choose a reason for hiding this comment

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

всё верно, мы ставим длинные тире

Copy link
Member

Choose a reason for hiding this comment

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

Это не роман, как и макосные кавычки (не потому, что макосники - меньшинство, а потому что кавычки, отличные от " крайне редко используются в технической документации), в доках это не нужно.
Сокращения it's из той же оперы, делает текст неформальным.

Почитайте, как люди пишут в доках, связанной с разработкой чего либо:
https://doc.rust-lang.org/book/appendix-01-keywords.html
https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines
https://www.w3schools.com/js/js_json_intro.asp
https://github.com/gorhill/uBlock/wiki/Static-filter-syntax

- [source/whotracksme.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/source/whotracksme.json) - contains information about trackers, fetched from whotracks.me.
- [source/trackers.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/source/trackers.json) - contains information about trackers, which overwrites or supplements [dist/whotracksme.json](https://raw.githubusercontent.com/AdguardTeam/companiesdb/main/dist/whotracksme.json).
- [dist/whotracksme.json] — just a copy of [source/whotracksme.json].
- [dist/trackers.json] contains information about trackers, obtained by merging the [source/trackers.json].
Copy link
Member

Choose a reason for hiding this comment

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

тут тире было уместным (везде где удалено).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"file contains information". каким образом тут уместно тире?

Choose a reason for hiding this comment

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

и тут Слава прав, тире не нужно

Copy link
Member

Choose a reason for hiding this comment

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

- [dist/trackers.json] contains information
каким образом тут уместно тире?

ну перечисление пунктов с их пояснением. Тире используется для читаемости, отделяет основную часть от пояснительной. В отличие от длинных тире и макосных кавычек, это не я придумал.

Choose a reason for hiding this comment

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

в основном тире ставится, когда нет глагола
здесь оно избыточно, всё и так читаемо


```json
"url": null
```

## Tracker categories

| # | Name | Purpose |
| Id | Name | Purpose |
Copy link
Member

Choose a reason for hiding this comment

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

Зачем?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

так вернее

@slavaleleka slavaleleka merged commit 52ae1ce into main Aug 5, 2024
2 checks passed
@slavaleleka slavaleleka deleted the fix/readme-002 branch August 5, 2024 15:24
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.

4 participants