Improve documentation on wiki pages: add table of contents, fix grammar, check if descriptions are up to date

rdmenezes / cefpython

Automatically exported from code.google.com/p/cefpython

1 stars 0 forks source link

Improve documentation on wiki pages: add table of contents, fix grammar, check if descriptions are up to date #150

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago

Table of contents can be added on wiki pages using `<wiki:toc />` tag.

Fix grammar, stylings. Avoid very long sentences.

Check if descriptions are up to date.

Removal of CEF 1 documentation should done along with Issue 106 "Remove CEF 1 
code path and update wiki pages".

Original issue reported on code.google.com by czarek.t...@gmail.com on 6 Dec 2014 at 10:18

Blocked on: #106

GoogleCodeExporter commented 9 years ago

[deleted comment]

GoogleCodeExporter commented 9 years ago

[deleted comment]

GoogleCodeExporter commented 9 years ago

Now that table of contents is being added, we could use direct links to 
specific functions/methods. Unfortunately there is a problem with doing that. 
If method arguments change, the anchor name will change as well. And that would 
break links to that method.

Original comment by czarek.t...@gmail.com on 6 Dec 2014 at 10:32

GoogleCodeExporter commented 9 years ago

[deleted comment]

GoogleCodeExporter commented 9 years ago

TOC was already added to some pages, see how it looks: 

  https://code.google.com/p/cefpython/wiki/Browser
  https://code.google.com/p/cefpython/wiki/Frame
  https://code.google.com/p/cefpython/wiki/ApplicationSettings
  https://code.google.com/p/cefpython/wiki/BrowserSettings
  https://code.google.com/p/cefpython/wiki/JavascriptBindings

Return value was moved to the right, after method name and arguments. It is so 
that table of contents is easier to view.

Original comment by czarek.t...@gmail.com on 6 Dec 2014 at 11:21