need xml style guide - Githubissues

ybakos / wayland

Core Wayland protocol and libraries

Other

0 stars 0 forks source link

Open ybakos opened 8 years ago

ybakos commented 8 years ago

Add to Contributing doco.

ybakos commented 8 years ago

Submit this with whitespace fixes?

ybakos commented 8 years ago

Case/capitalization of summaries. spacing of version comments, other vertical whitespace (eg between descriptions and args)

ybakos commented 8 years ago

Prefer active voice. eg:

_The popupdone event is sent out when a popup is dismissed by the compositor.

Should ideally be:

_The compositor emits a popupdone event when it dismisses a popup.

ybakos commented 8 years ago

Spaces after periods

ybakos commented 8 years ago

summaries on new line?

ybakos commented 8 years ago

Start with leading article, eg, "the" ?

Most of the argument summary attribute values don't begin with the article "the," yet many do.

Suggested rule:

use the only when not using it is cumbersome. e.g "the offer..." is better than "offer..." ??

ybakos commented 8 years ago

All requests after/before events (note order).

ybakos commented 8 years ago

Look at the comments generated from the xml to help guide some decisions. Eg, Initial capitalization, etc.