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

Avoid auto-translation of API names, language keywords, and other literals #2269

Open
kwalrath opened this issue Feb 10, 2020 · 4 comments
Open
Labels
a.language Relates to the Dart language tour a.libraries Relating to the Dart standard libraries. co.help-wanted Community opportunity to help documentation e2-days Can complete in < 5 days of normal, not dedicated, work infra.design Relates to the design of docs.Dart.dev p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.l10n Relates to localizing Dart text in apps

Comments

@kwalrath
Copy link
Contributor

kwalrath commented Feb 10, 2020

Code font is the obvious fix, but it's ugly and takes up a lot of space, so it seems a shame to use it in places where a human can tell that you're talking about something literal. Tables and API docs are especially poor places to be forced to use code font.

This is an issue for all of our sites, including (but almost certainly not limited to) dart.dev and api.dart.dev.

For more details, see #2266.

@kwalrath kwalrath added p2-medium Necessary but not urgent concern. Resolve when possible. co.help-wanted Community opportunity to help documentation t.l10n Relates to localizing Dart text in apps e2-days Can complete in < 5 days of normal, not dedicated, work p1-high Major but not urgent concern: Resolve in months. Update each month. and removed p2-medium Necessary but not urgent concern. Resolve when possible. labels Feb 10, 2020
@kwalrath kwalrath changed the title Use code font to avoid auto-translation of language keywords Avoid auto-translation of API names, language keywords, and other literals Feb 10, 2020
@kwalrath
Copy link
Contributor Author

@johnpryan
Copy link
Contributor

johnpryan commented Feb 10, 2020

we could try class="notranslate" according to this StackOverflow answer

@legalcodes
Copy link
Contributor

I want to +1 this:

Code font is the obvious fix, but it's ugly and takes up a lot of space

The flutter/website codefont styles might be due for revisiting. I'm not convinced that our bright hyperlink-blue mixes well with the dark forest green we're using for code font on flutter.dev:

Screen Shot 2020-02-11 at 1 46 57 PM

Screen Shot 2020-02-11 at 1 49 06 PM
Screen Shot 2020-02-11 at 1 49 15 PM

The reason I'm including this point in this issue is because if codefont were less ugly, that might enable us to use it more than we are currently, which would help with auto-translation problems that we're running into here.

@kwalrath
Copy link
Contributor Author

I'm going to downgrade to P2 since this is going to take some time, and it mostly works now.

@kwalrath kwalrath added p2-medium Necessary but not urgent concern. Resolve when possible. and removed p1-high Major but not urgent concern: Resolve in months. Update each month. labels Feb 14, 2020
@kwalrath kwalrath added a.language Relates to the Dart language tour a.libraries Relating to the Dart standard libraries. labels Jul 22, 2021
@kwalrath kwalrath self-assigned this Jul 22, 2021
@atsansone atsansone added infra.design Relates to the design of docs.Dart.dev st.triage.ltw Indicates Lead Tech Writer has triaged labels Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.language Relates to the Dart language tour a.libraries Relating to the Dart standard libraries. co.help-wanted Community opportunity to help documentation e2-days Can complete in < 5 days of normal, not dedicated, work infra.design Relates to the design of docs.Dart.dev p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.l10n Relates to localizing Dart text in apps
Projects
None yet
Development

No branches or pull requests

4 participants