Repository navigation
Update functionsignatures in utilities, by adding missing function signatures - #129
Open
matteozanettii wants to merge 1 commit into
Open
matteozanettii wants to merge 1 commit into
matteozanettii wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
Update
functionsignaturesby adding missing function signaturesMain reason
This PR updates the FSDA
functionsignaturesmetadata by adding the function signatures that were still missing.The current
functionsignaturesonly documentsgetTickers,getYahoo,getFundamentals, andzscoreFS. This PR extends it to cover the remaining functions of the toolbox, so that the metadata is aligned with the current FSDA API and can be used reliably for documentation generation, argument validation, and developer tooling.What changed
New function signatures added (24)
cabccascadeclickableMultiLegenddocrootFSexistFSextendVECfindDirfindFileisfunctionm2ipynbmedcouplemultialign2refmultialignHeaderopenMatlabFileFromHTMLpdfprotectpositionquickselectFSquickselectFSnwquickselectFSwremoveExtraSpacesLFrepDupValWithMeanrescaleFSrows2varsFSRatcliffeObesrhelpFor
cabcandcascade, the entries are included with emptyinputs/outputs, since no arguments are currently documented for those functions.Update to an existing entry
zscoreFS: added'modmadp'to the allowed values of thescaleargument, bringing the signature in line with the implemented function.Conventions
All added entries follow the existing schema format (
_schemaVersion: "1.0.0") and use the same conventions already adopted in the file:required,namevalue, andorderedargument kindschar,string,double,logical,table,struct,cellstr, ...)scalar,vector,integer,>=1,<=1,numel=3, ...)choices={...}purposefieldsImpact
functionsignatures.Notes