[DOC] Add Documentation Header for Builtin Functions#1401
Closed
atefeh-asayesh wants to merge 1 commit intoapache:mainfrom
Closed
[DOC] Add Documentation Header for Builtin Functions#1401atefeh-asayesh wants to merge 1 commit intoapache:mainfrom
atefeh-asayesh wants to merge 1 commit intoapache:mainfrom
Conversation
…builtin Functions:
j143
reviewed
Nov 24, 2021
Member
There was a problem hiding this comment.
Hi! 😃
Thanks a lot for working on this. I will merge the following after changes
as two clean commits.
Part 1:
- 1.
applyAndEvaludate.dml - 2.
bandit.dml - 3.
components.dml - 4.
correctTypos.dml - 5.
cvlm.dml
Part 2:
- 6.
dmv.dml - 7.
ema.dml - 8.
executePipeline.dml - 9.
gnmf.dml - 10.
hyperband.dml
What you can do now?
-
Revert the file changes in the remaining files
click to know
how to do it- switch to BuiltinHeader1
git checkout BuiltinHeader1
- Uncommit this commit, to keep the changes
git reset HEAD^
- And add only these 10 files, like
git add scripts/builtin/applyAndEvaluate.dml scripts/builtin/bandit.dml
- Now, commit
git commit -m "add documentation header" -
That's it!
| @@ -1,4 +1,4 @@ | |||
| #------------------------------------------------------------- | |||
| # ---------------------------------------------------------------------------------------------------------------------- | |||
Member
There was a problem hiding this comment.
We should not change this one, this will add inconsistency with license header.
Member
There was a problem hiding this comment.
100's of dml files use this same header!
| for line in markDownArray: | ||
| if INPUT: | ||
| inputParameterCount, INPUT, INPUT_FINISHED, I_HEADER_MISSING, commentLineCount = parseParam(inputParameters, inputParameterCount, INPUT, INPUT_FINISHED, I_HEADER_MISSING, commentLineCount, additionalInfos, line) | ||
| inputParameterCount, INPUT, INPUT_FINISHED, I_HEADER_MISSING, commentLineCount = parseParam(inputParameters, inputParameterCount, INPUT, INPUT_FINISHED, I_HEADER_MISSING, commentLineCount, additionalInfos, line, OUTPUT) |
Member
There was a problem hiding this comment.
This script needs to be well tested 🥇 . For now, we can use this only 1 or 2 scripts in scripts/staging folder. After which, we can apply generically. 😃
j143
changed the title
Contributor
|
Closing because i am merging in other PR #1492 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this PR we add missing Builtin Function Header for all the script/builtin Functions, Specifically, add a header to each such
builtin dml file with a brief summary, input parameters, and outputs.