You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@wicket.apache.org by jmewes <gi...@git.apache.org> on 2018/11/22 15:34:23 UTC

[GitHub] wicket pull request #340: Improve formatting of example snippet

GitHub user jmewes opened a pull request:

    https://github.com/apache/wicket/pull/340

    Improve formatting of example snippet

    

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/jmewes/wicket docs/improve-code-format

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/wicket/pull/340.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #340
    
----
commit 1651aaf10f666ce022702f1e08cd1493f1052b1f
Author: Jan Mewes <ja...@...>
Date:   2018-11-22T15:30:56Z

    Improve formatting of example snippet

----


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by martin-g <gi...@git.apache.org>.

Github user martin-g commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    @paulbors Any improvements are very welcome!


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by bitstorm <gi...@git.apache.org>.

Github user bitstorm commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    thank you @jmewes !


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by solomax <gi...@git.apache.org>.

Github user solomax commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    I would not change `tab` with 2 spaces for whole project
    Even this markup can have `tab` and will be readable if CSS will be in separate file
    
    my 2c


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by jmewes <gi...@git.apache.org>.

Github user jmewes commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    Currently this snippet is hardly readable in the documentation:
    
    ![before](https://user-images.githubusercontent.com/5235584/48911937-90566c00-ee74-11e8-8cd0-a664ae9323e2.png)
    
    With this commit is should become better:
    
    ![after_png](https://user-images.githubusercontent.com/5235584/48911958-9e0bf180-ee74-11e8-8245-2aaf85dd6d37.png)
    



---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by paulbors <gi...@git.apache.org>.

Github user paulbors commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    Hey @martin-g,
    
    I haven't looked over Wicket's code in a while, but if the proj has a code style we all agree on I don't mind configuring that in IntelliJ (export to Eclipse and check in the code styles) and letting it automatically adjust the entire source code. I've done it in the past and we ended up with an uber PR that's look a bit messy (will take a while to review, but then again Wicket seems pretty stable now-a-day).
    
    Is there such a style guide or should we create a new one?


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by paulbors <gi...@git.apache.org>.

Github user paulbors commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    Should we not consider a code style machine cleanup for the entire project?


---

[GitHub] wicket issue #340: Improve formatting of example snippet

Posted by paulbors <gi...@git.apache.org>.

Github user paulbors commented on the issue:

    https://github.com/apache/wicket/pull/340
  
    I tend to agree as this proj is widely used and a bug can easily creep in even with the extensive test coverage. If it wasn't as popular it would have made more sense. The kind of good problems to have :)
    
    However, the question still remains: should the comitee vote on adopting a single uniform code style and enforce it going forward? Over time the code base can be refactored to catch up.


---