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

Update README in gui/scripts #6370

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Update README in gui/scripts #6370

merged 1 commit into from
Jun 25, 2024

Conversation

raksooo
Copy link
Member

@raksooo raksooo commented Jun 18, 2024

This PR updates the readme in gui/scripts to reflect the changes made to the localization scripts in #6241.


This change is Reviewable

Copy link
Contributor

@MarkusPettersson98 MarkusPettersson98 left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @raksooo)


gui/scripts/README.md line 17 at r1 (raw file):

### Update translations

See [../locales/README.md](../locales/README.md) for information about how to handle translations.

Nit We could skip the .. when formatting the link

See [locales/README.md](../locales/README.md)

Code quote:

See [../locales/README.md](../locales/README.md) 

gui/scripts/README.md line 19 at r1 (raw file):

See [../locales/README.md](../locales/README.md) for information about how to handle translations.

The `/scripts/localization` script is, among other things, calling into `fetch-relay-locations.py`

Nit Is / how we are supposed to refer to the project root in documentation? 😊
Would it be less clear if we replaced /scripts/localization with scripts/localization?

Code quote:

The `/scripts/localization`

gui/scripts/README.md line 24 at r1 (raw file):

* `fetch-relay-locations.py` fetches the relay list and extracts all country and city names.
* `intregrate-relay-locations.py` integrates the fetched relay locations into
`../locales/relay-locations.pot`.

Nit Either make this a markdown link, or format it relative to the project root:

gui/locales/relay-locations.pot

Code quote:

../locales/relay-locations.pot

@raksooo raksooo force-pushed the improve-gui-scripts-readme branch from 023ff38 to 037ba89 Compare June 25, 2024 12:04
Copy link
Member Author

@raksooo raksooo left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, all discussions resolved (waiting on @MarkusPettersson98)


gui/scripts/README.md line 17 at r1 (raw file):

Previously, MarkusPettersson98 (Markus Pettersson) wrote…

Nit We could skip the .. when formatting the link

See [locales/README.md](../locales/README.md)

Done.


gui/scripts/README.md line 19 at r1 (raw file):

Previously, MarkusPettersson98 (Markus Pettersson) wrote…

Nit Is / how we are supposed to refer to the project root in documentation? 😊
Would it be less clear if we replaced /scripts/localization with scripts/localization?

Done.


gui/scripts/README.md line 24 at r1 (raw file):

Previously, MarkusPettersson98 (Markus Pettersson) wrote…

Nit Either make this a markdown link, or format it relative to the project root:

gui/locales/relay-locations.pot

Done.

Copy link
Contributor

@MarkusPettersson98 MarkusPettersson98 left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

Copy link
Collaborator

@albin-mullvad albin-mullvad left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@raksooo raksooo force-pushed the improve-gui-scripts-readme branch from 037ba89 to 0683ec1 Compare June 25, 2024 13:24
@raksooo raksooo merged commit ea9d4b1 into main Jun 25, 2024
7 checks passed
@raksooo raksooo deleted the improve-gui-scripts-readme branch June 25, 2024 13:28
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.

3 participants