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

minor fix for introduction. #318

Closed
wants to merge 1 commit into from
Closed

minor fix for introduction. #318

wants to merge 1 commit into from

Conversation

kyao233
Copy link

@kyao233 kyao233 commented Oct 3, 2018

Make sentence more smooth.

@CodeingBoy
Copy link
Contributor

CodeingBoy commented Mar 25, 2019

I don't think this change is necessary.
Reasons:

  1. The first sentence's subject is MyBatis-Spring, no need to clarify again in second sentence.
  2. The last sentence is showing the results, again, no need to explicitly emphasize MyBatis-Spring. Actually, in my view, this is less smooth.

这个修改没有必要。

  1. 第一句的主语已经指明了主语是 MyBatis-Spring,接下来的句子不需要再用“这个库”来指明主语。
  2. 最后的句子的重点在于展现 MyBatis-Spring 的作用,没有必要强调“它”。其实我觉得这样读起来反而还怪怪的。

EDIT: typo

@kazuki43zoo
Copy link
Member

@kyao233 Could you check @CodeingBoy 's comment?

@kyao233
Copy link
Author

kyao233 commented Apr 3, 2019

  1. This library allows MyBatis to participate in Spring transactions.
  2. it lets you build your application code free of dependencies on MyBatis.

I just want to make it's translation as close as its English version.

At least, I think the subject in second sentence is neccessary.

@CodeingBoy
Copy link
Contributor

No, you should do mean-by-mean translations instead of word-by-word translations. The translated documentation needs not always fit in the original English documentation. For readability, you can re-express them in native language.
Let's have a look at this example:

In this example, annotations are used to specify the SQL, but a MyBatis mapper XML file could also be used.

在这个示例中通过注解来指定SQL语句,但是通过MyBatis映射器的XML文件也行。

By comparing them, you will find that they're really really close. But reading the translated one will make you feel odd, you know, odd.

So I rewrote to this:

在这个示例中,通过注解来指定 SQL 语句,但是也可以使用 MyBatis 映射器的 XML 配置文件。

In this example, (we) use annotation to specify SQL statement, but (we) can also use MyBatis mapper XML file.

By reordering parts of this sentences, better readability presents.

From your point of view, you may rewrite to this:

在这个示例中,注解被用于指定 SQL,但一个 MyBatis 映射器 XML 文件也可以。

In this example, annotations are used to specify the SQL, but a MyBatis mapper XML file could also be used.

No, that does not make sense in Chinese. At least, it's odd.

So, please reconsider your changes. Read them several times before you submitting them, don't think about English one - you're reading a Chinese documentation! (unless you notice something BIG had dropped)

@mallim
Copy link

mallim commented Apr 4, 2019

+1 for 在这个示例中,通过注解来指定 SQL 语句,但是也可以使用 MyBatis 映射器的 XML 配置文件。

@kyao233
Copy link
Author

kyao233 commented Apr 4, 2019

What I did is not word-by-word translation and I don't want to do that, the issue is translation could be different from its English version but should fully express its meaning.

For the sentences in your example, I didn't see too much difference.For which one you prefer I think it's just personal opinion and majority wins.

@CodeingBoy
Copy link
Contributor

CodeingBoy commented Apr 4, 2019

So in your view "it" is not "fully express its meaning", but "this library" will do? And expressing the effect is not "fully express its meaning", but with adding "it" is "fully express its meaning"? I don't see any difference since they are actually the same thing.

For which one you prefer I think it's just personal opinion and majority wins.

Read the diff of #297. If you still think it's all my "personal opinion", submit a reversion.

Anyway, I do expressed my opinions about your changes, and I will not stand in your way again. If you insist that, go ahead and get merged.

@kyao233
Copy link
Author

kyao233 commented Apr 6, 2019

hahaha, OKOK, I will close my MR for this one.

@kyao233 kyao233 closed this Apr 6, 2019
@CodeingBoy
Copy link
Contributor

hahaha, OKOK, I will close my MR for this one.

Great, thanks for your understanding. In fact, I'm very happy to see users start contributing to documentations.
If you have spare time, or you are learning MyBatis-Spring, please read through documentations and submit the changes you would love to make. We will review and merge them if it really can improve the reading experiences. I would say there are still lot of words needs improving(I found several during reading them, even after I submitted #297). So keep calm and keep looking at them.

@kazuki43zoo
Copy link
Member

@CodeingBoy and @kyao233,

Thanks for your contributing! Contributions are always welcome.

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.

None yet

4 participants