-
General docs:
- Pre-requisites
- Pre-build steps (remove moc instructions as no longer needed)
- Build steps
- Code structure
- wxQt Helpers (class hierachy)
- Folders and files
- Status (supported c…
-
- [Pydoc](https://docs.python.org/2/library/pydoc.html)
- [Sphinx](http://sphinx-doc.org/tutorial.html)
-
What is the project's policy on documentation? If there is one I'd like to suggest creating a wiki page that outlines the format and content of docs. We should also have a page on code style to make i…
-
Convert python code to glue syntax then spit out docs. Easy to do - switch comments to non-comments and wrap uncommented sections in `---code python\n[CODE HERE]\n...` and spit it back out. Could be a…
-
It would be cool if there were an optional param in the config file like `updateDocsCodeComments` that, if set to true, would scan code changes to see if any comments were added and count that as docu…
-
It would be easier for external users to read the code if some important steps were documented (with a comment).
Most importantly, it would be useful to write variable names with full and explicit…
-
### Current behaviour
[https://github.com/CasparCG/server/blob/b0ecbeea48e9a9548199ed1d2cf0d241fa3695fa/src/modules/ffmpeg/producer/av_producer.cpp#L273](https://github.com/CasparCG/server/blob/b0ecb…
jpc0 updated
11 months ago
-
The README.md has a text block showing the output of `tree /srv/salt`.
This listing shows a file named `patch_hana.py` in `_modules` but this file in not present in the code.
Is the listing inco…
-
### Is your feature request related to a problem?
* Typings in code
* Typen von standardisierten Dokumentationsformaten (numpy-doc, epy-doc, rest, google style)
* numpy-doc und epy-doc wurden…
-
**Describe the idea you had**
Maybe we could find out module names and then add them into the code with some kind of `self flag ...` with symbol based on a calculated slice.
**Additional context…