-
Notifications
You must be signed in to change notification settings - Fork 102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation of functions #751
Labels
Milestone
Comments
hohwille
added
enhancement
New feature or request
documentation
related to documentation (AsciiDoc)
Campus_22_1_ide
labels
May 17, 2022
See #729 |
hohwille
pushed a commit
that referenced
this issue
Sep 9, 2022
hohwille
added a commit
to hohwille/ide
that referenced
this issue
Oct 7, 2022
hohwille
added a commit
that referenced
this issue
Oct 7, 2022
hohwille
added a commit
to hohwille/ide
that referenced
this issue
Oct 7, 2022
hohwille
added a commit
to hohwille/ide
that referenced
this issue
Oct 7, 2022
hohwille
added a commit
to hohwille/ide
that referenced
this issue
Oct 7, 2022
hohwille
added a commit
that referenced
this issue
Oct 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
As a new devonfw-ide developer, I want to get some documentation about the
functions
so that I can understand easier which functions are available, what they do and how to use them without digging and reverse-engineering the code.The functions are complex and long (>1000 lines). It is not properly documented and adding extensive documentation here might have some downsides as the script has to be parsed by bash all the time and extensive comments would massively increase the file length and size.
Therefore we instead want to add a
documentation/functions.asciidoc
file as documentation to functions.Here we should have a heading for each function with a description of the function (e.g.
doInstall
) in a common format (e.g. using a table or numbered list points for parameters, etc.).As this is quite some work, it would IMHO be a good idea to first start with a single function as example and then introduce the result to the entire team to get feedback before documenting all other functions in the same way.
This story is slightly related to #729
The text was updated successfully, but these errors were encountered: