Comments (7)
Thanks @RBastianini, I really appreciate it. There's no rush to complete the task, so we have ample time before the update will be published.
Do you want me to look at something in particular?
Typos, left over Italian sentences (which were placed side-by-side with the English to aid translation) or untranslated terms, and possibly duplicate paragraphs (sometime I wrote alternative translations but then forgot to keep just one of them), and possibly check the examples sources and productions.
During the original editing I basically ported to markdown the original PML doc, which was an incomplete translation of the Italian version, and tried my best to polish the English, update it to match the Italian version (which was more recent) and complete the untranslated parts. I also adapted to English many examples which were originally in Italian, so the production output was manually filled in (not generated via Polygen).
If you spot anything worth amending, just open an Issue for it.
I shall do all the editing work in a dev branch, and finally squash all the changes into a single commit once it's ready.
I'll probably ask both you and Alvise for a final proof-reading before merging into master
, but that will be sometime in Autumn.
from polygen-docs.
I'd be happy to. I might have a couple of free evening this coming week. Do you want me to look at something in particular?
from polygen-docs.
I did a first read through sections 1-2.4 (included) and I opened a couple of issues. I grouped some issues together instead of opening a ticket for each typo / suggestion. I did that so the issue tracker does not become crowded with very small tickets. Let me know if you'd prefer to split them further.
from polygen-docs.
I did a first read through sections 1-2.4 (included) and I opened a couple of issues.
thanks a lot Riccardo I really appreciated.
I've started working on some structural fixes to the repository and will then update the toolchain dependencies, and after that I'll finally be able to start working on the updated documents (it's worth doing the updates first, so we can spot any template/styles problems that might ensue).
I grouped some issues together instead of opening a ticket for each typo / suggestion.
That's fine, I did that too. Also, these are often typos close to each other.
from polygen-docs.
Final Proof-Reading Before Weekend
ETA → On Sunday 13 September I'll be releasing v1.1.1
.
Since this Issue was opened many typos were found and fixed, duplicate or original Italian left-over paragraphs removed, sentences wording improved and a few examples were fixed (thanks @RBastianini!).
I was planning to release v1.1.1
during the weekend, so we can replace the errors-ridden English document with a cleaner version, and benefit from the updated toolchain (text improvements will be handled in the second next release, see #36).
So, @alvisespano and @RBastianini, if you feel like going through the PML Spec docs (English and Italian) once more before the weekend, and point out any typos or things that need to be fixed, please go ahead. (I'll be going over both docs myself during the week.)
PS: I'll buzz Alvise via email 'cos I think he's not receiving GH notifications about repository activity.
from polygen-docs.
Hey guys! Very nice work! I've been pretty busy lately. Looks like you're more committed to the project than me at the moment :D
I've seen the new stuff, though just superficially due to time constraints. Go for the release anyway!
from polygen-docs.
I think I might have some spare time tomorrow later today to read some more portions of the documentation. I haven't completed my first re-read, so I'll try to get through it instead of starting over.
from polygen-docs.
Related Issues (20)
- Highlight Assets no Longer Required HOT 2
- Create Release v1.1.0 HOT 1
- Switch Downloader to Bash Script and Use Tar HOT 1
- PML EN: Typos in §2.3
- PML EN: Typo in §1 HOT 1
- Misc suggestions for section §2.4 (and nested paragraphs) HOT 3
- Preparing Release 1.1.1
- Misc suggestions for section 2.5 and 2.6
- Implicit / missing details about label selection HOT 5
- Document Repo and Docs Versioning Scheme
- Release 1.1.1 Checklist
- Examples with Labels before They Are Introduced HOT 1
- Fix PP Macros to Work with Latest PP HOT 1
- Add CHANGELOGs
- Misc suggestions for section 2.7 - 2.10 HOT 3
- Revising and Improving PML Docs Contents
- Fix Examples in §2.7 Permutazioni
- PML Spec IT: Fix Title Style in §4.2.2.1
- Suggestions for sections 2.11 up to section 3 HOT 2
- Duplicated paragraph in section 3 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from polygen-docs.