search

brailleapps / dotify.formatter.impl

Provides an implementation of the formatter interfaces in dotify.api
GNU Lesser General Public License v2.1
0 stars 6 forks source link

Documentation (Javadoc + comments) #102

Closed bertfrees closed 5 years ago

bertfrees commented 5 years ago

I have gone through the whole diff and checked for every change whether it was incorporated or not. Most of my additions (mostly Javadocs and some comments) have not been incorporated yet, and a part of Paul's additions (mostly questions and comments) have not been incorporated/processed yet either.

I suggest that I first select all my remaining changes, clean them up/improve them and make a new PR from it. I also try to answer some more of Paul's questions.

After the first PR is merged I send Paul the list of his remaining changes and that should result in a second PR.

bertfrees commented 5 years ago

I'll rebase this PR when https://github.com/brailleapps/dotify.formatter.impl/pull/107 is merged.

bertfrees commented 5 years ago

Rebased onto master.

kalaspuffar commented 5 years ago

Hi @bertfrees

Is this PR still a work in progress? What is left to improve before review? Do we have any loose estimate when it's ready?

Best regards Daniel

bertfrees commented 5 years ago

This is just the remaining stuff from the original PR that are not merged. Everything that was mergeable has been merged basically. What is left are the comments from Paul that I didn't know how to integrate. I guess @PaulRambags should have a look at it and we should get a discussion going if there is something that Paul wants to keep.

But this doesn't need to go in Q3 I would say.

PaulRambags commented 5 years ago

Although the PR contains some Q(uestions) and A(nswers), I wouldn't mind to merge it as it is, with the code change removed as it is now in #109

bertfrees commented 5 years ago

No, I would mind :-). There is a reason why I did not incorporate these yet. Let's just discuss them one by one on gitter/Slack.

bertfrees commented 5 years ago

Work in progress can be seen here: https://github.com/brailleapps/dotify.formatter.impl/compare/master...documentation-2. Will finish it later.