Fix errors and typos in some docs #838
Open
Conversation
This file contains 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
Some function parameters were missed.
Remove comma after last function parameter.
1) Function signature must be terminated by a semicolon. 2) Condense short code to single lines. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/BLISTypedAPI.md modified: docs/KernelsHowTo.md
Remove trailing whiespaces. Changes to be committed: modified: docs/KernelsHowTo.md modified: docs/Performance.md modified: docs/ReleaseNotes.md
Make indents of proper size for parentheses and function arguments.
Sync docs with 31c8657 commit. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/BLISTypedAPI.md
Highlight syntax as for C source, not as for a shell script. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/ReleaseNotes.md
Make their content more similar to each other. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/BLISTypedAPI.md
Mention new global scalar constants: BLIS_ONE_I, BLIS_MINUS_ONE_I, BLIS_NAN.
Use 'const' pointers. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/BLISTypedAPI.md
Use 'void*' datatypes.
'is_eq' parameter must has no 'const' qualifier in bli_eqsc and bli_eq[vm] functions. Fixes the commit 69feae7.
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.
Details:
docs/BLIS*API.md,docs/BLIS*API.mdwith the current code base.BTW, a question about one discrepancy in function signatures:
bli_?print[vm]use the typeconst void*forxparameter, butbli_?fprint[vm]use the typeconst ctype*. Is this made intentionally?