Skip to content

fights bit rot in macro docs #378

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

Merged
merged 8 commits into from
Sep 25, 2014
Merged

fights bit rot in macro docs #378

merged 8 commits into from
Sep 25, 2014

Conversation

xeno-by
Copy link
Contributor

@xeno-by xeno-by commented Sep 21, 2014

review @eed3si9n

@xeno-by
Copy link
Contributor Author

xeno-by commented Sep 21, 2014

Eugene, thanks to Shimamoto-san's presentation, I've found a number of very important omissions and obsolete statements in current macro docs. I've fixed those in the English version, but what bothers me is that the Japanese version that still has the problems.

I'm very grateful to you for providing the initial Japanese translations, and by no means I want to impose the burden of updating them onto you. Therefore, maybe we could just archive the existing translations for the time being? What do you think?

@eed3si9n
Copy link
Member

From the Japanese reader's point of view document going offline when there's a gap between the original is very inconvenient, so maybe the middle way would to put up a sign at the top of the document saying it's currently obsolete for 2.11|12/paradise/scala.meta etc.

If it's not too much work, I don't mind translating once in a while. Another thing we should try is to advertise that the translation resource is wanted on scalajp list, when I'm too busy. ScalaMatsuri had 300+ people listening to Martin's talk in Japan. I'm sure there are a few who would be happy to lend their Japanese language power for macros (or any other official docs).

@xeno-by
Copy link
Contributor Author

xeno-by commented Sep 22, 2014

I'm concerned about some parts of the content being plain wrong in the current state of things. Even if we put the deprecation notice, I fear that some people might ignore it (or legitimately not see it if they use a permalink to navigate to a portion of page). Do you think that might be a problem?

Thanks for your kind offer! How about then we first go for a post at scalajp, because the volume of the docs probably doesn't qualify for "not too much work", even if you only count the delta. Afterwards, I will put you in /cc of my documentation pull requests, and those tend to be reasonably small. WDYT?

@xeno-by
Copy link
Contributor Author

xeno-by commented Sep 25, 2014

Allright, I think I'll merge this for now, and if our discussion concludes with a need in submitting a follow-up pull request, I'll do that separately.

xeno-by added a commit that referenced this pull request Sep 25, 2014
fights bit rot in macro docs
@xeno-by xeno-by merged commit ccaee95 into scala:master Sep 25, 2014
@eed3si9n
Copy link
Member

I'll try to bring the macro translations up to date in a week or two.

@xeno-by
Copy link
Contributor Author

xeno-by commented Sep 25, 2014

Thank you!

@eed3si9n
Copy link
Member

Started working on this here - https://github.com/eed3si9n/scala.github.com/commits/topic/tracking-macros. I'm caught up to November 16th, 2013.

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.

2 participants