Documentation rules #4779
Replies: 3 comments 2 replies
-
|
+1 for surrounding them with |
Beta Was this translation helpful? Give feedback.
-
|
Since the API is intended to be backward-compatible for future versions it would be good to add a note in which version a feature was introduced for all functions added after v1.0. |
Beta Was this translation helpful? Give feedback.
-
|
According to the doc you can use: Not tested. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks :) Looks good: |
Beta Was this translation helpful? Give feedback.
-
|
whohoo... is there someone working on different types of ships? 👍 Don't forget real life. It's somewhere out of here :) |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
I've started to make a wikiarticle about documentation rules: https://www.widelands.org/wiki/Documentation%20Rules/
Since i want to work on the documentation i have a question about string constants like e.g. for roadtypes: Currently they are formatted like ‘normal’, ‘busy’, or ‘waterway’. Since they are strings we should use another formatting imho. Something like
"normal","busy", or"waterway"?What do you think?
Beta Was this translation helpful? Give feedback.
All reactions