Marwes / combine

A parser combinator library for Rust
https://docs.rs/combine/*/combine/
MIT License
1.29k stars 93 forks source link

Translate wiki docs into Japanese, and add a link to README #345

Closed sadnessOjisan closed 2 years ago

sadnessOjisan commented 2 years ago

Hi, I am a fan of your cool library. I translated some wiki docs into Japanese. Can I publish it as public? And If you’d like, can I add a link in README.md?

gemmaro commented 2 years ago

First of all, I think it's good to have translation, especially for introductory information 🙂

On the other hand, I am concerned about the following two points.

Marwes commented 2 years ago

I think it is fine to have a link to a translation, combine is more or less feature complete so I don't expect documentation to change much anyway and if it still changes to make the translation out of date then hopefully anyone using it will figure that out.

Tests are failing because I used the readme to test that some async parsers work as intended so the number of words it tests against needs to be updated.

sadnessOjisan commented 2 years ago

@gemmaro

Updating tediousness

In that case, I will periodically compare the original with mine. My repository contains the original doc(copied from wiki). About po4a, today I learned it. It's a cool tool and I want to use it.But I don't want to use it now because I have to learn how to use it from scratch.I want to eventually migrate, so I'm researching it now.

Location where information should

I want to use the GitHub repository to dif original docs. If original tutorials are written in the GitHub repository, I think Japanese docs also should be in combine repo.But now docs are in the wiki, I think docs will be in another repository.

sadnessOjisan commented 2 years ago

@Marwes Thanks. I was unaware that testing is needed when changing README. I updated the test.

sadnessOjisan commented 2 years ago

Oops, failed test? It was successed on my local machine. Check again.

sadnessOjisan commented 2 years ago

@Marwes Sorry I forgot to run sh ci.sh just run cargo test. I checked the GitHub Actions workflow and test it. Could you re-run actions? Screen Shot 2022-04-27 at 1 24 07