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

I18n README.md improvement #2962

Merged
merged 2 commits into from Oct 23, 2017

Conversation

Projects
None yet
3 participants
@JocelynDelalande
Copy link
Contributor

JocelynDelalande commented Oct 21, 2017

Following the i18n effort started by @JCEmmons with #2140 (thanks a lot for that!!), I'd like to add my tiny contribution, smoothing the (quite rough at the moment) i18n documentation.

I know this is just a step, and that next steps are to improve tooling and script more things in the translation process. But I believe a clearer documentation is an interesting step anyway :-). At least, it helped me to understand better the 18n mechanism as introduced in #2140 (I'm working on french translation).

What do you think ?

JocelynDelalande added some commits Oct 21, 2017

Make the i18n README more clear
This README.md is the only documentation for i18n setup, let's enhance
it.

Modifications include:

- make the writing style less personal
- fix markdown (syntax, headings…)
- clearly separate the usage guide from the known bugs and future perspectives
  (as this guide is now in master branch, it is no longer relevant to say that
  it is an experimental thing)
- rewordings
Use local paths for i18n-related commands
Make the commands listings shorter and easier to focus on what matters.

@takluyver takluyver added this to the 5.3 milestone Oct 23, 2017

@takluyver

This comment has been minimized.

Copy link
Member

takluyver commented Oct 23, 2017

Thanks, I think this looks good, and I'm glad you're interested in working on it.

@takluyver takluyver merged commit 513709b into jupyter:master Oct 23, 2017

4 checks passed

codecov/patch Coverage not affected when comparing 1405693...bd48b42
Details
codecov/project 79.01% remains the same compared to 1405693
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@JocelynDelalande JocelynDelalande deleted the JocelynDelalande:i18n-readme-improvement branch Oct 23, 2017

@JocelynDelalande

This comment has been minimized.

Copy link
Contributor Author

JocelynDelalande commented Oct 23, 2017

@takluyver you are welcome, thanks for your work on jupyter!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.