search

Drakulix / zwreec

Twee to Z-Code Compiler in Rust
BSD 2-Clause "Simplified" License
7 stars 3 forks source link

Feature/utils documentation #269

Closed Drakulix closed 9 years ago

Drakulix commented 9 years ago

Hab was nach #212 im Utils Modul noch fehlte hinzugefügt. Oder fehlt jemandem noch was?

fgr0 commented 9 years ago

Ich würde bei utils/mod.rs noch einen Absatz mehr reinmachen, etwa so:

Utility code for more ituitive and shorter code

The submodules move Extensions or complex Error Handling out of the core modules (frontend/backend). For actual usage take a look at the corresponding submodule.

Allgemein sollte die erste Zeile immer kurz (<80 Zeichen) sein, laut Docstyle-RFC.

Ansonsten +1

Drakulix commented 9 years ago

Oh okay, ja hätte mir vielleicht die RFCs nochmal durchlesen sollen. Kommt sofort

fgr0 commented 9 years ago

Für alle: http://doc.rust-lang.org/nightly/book/documentation.html#writing-documentation-comments und https://github.com/rust-lang/rfcs/blob/master/text/0505-api-comment-conventions.md

80 Zeichen steht da zwar nicht direkt, aber das ist für Git-Commits immer so die Angabe für was "Kurz" heißt.

stilleben commented 9 years ago

Ich finde das so in Ordnung, also nochmal +1. Ich merge.