Fix errors and typos in some docs#843
Merged
devinamatthews merged 13 commits intoflame:masterfrom Jan 21, 2025
Merged
Conversation
1. Some integer-based types were missed. 2. Some function parameters were missed. Changes to be committed: modified: docs/BLISObjectAPI.md modified: docs/BLISTypedAPI.md
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
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.
Recreate omitting fragments.
Member
|
@jip thanks for rebasing. I'll check over the PR shortly. As for the questions:
|
|
|
||
| ### Operation implementation type query | ||
|
|
||
| The following routines allow the caller to obtain a string that identifies the implementation (`ind_t`) that is currently active (ie: implemented and enabled) for each level-3 operation. Possible implementation types are listed in the section above covering [microkernel implemenation query](BLISTypedAPI.md#microkernel-implementation-type-query). |
Member
There was a problem hiding this comment.
The data type should probably be mentioned here since sd will always return BLIS_NAT while cz could return other values.
Partially undo 4b92ba6 commit for bli_?print[vm]: there should be ctype* instead of void*.
Contributor
Author
I've added a correcting commit for docs/BLISTypedAPI.md . |
Member
|
Thanks! |
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
2 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.
Details:
docs/BLIS*API.md,docs/BLIS*API.mdwith the current code base.BTW, questions:
bli_?print[vm]use the typeconst void*forxparameter, butbli_?fprint[vm]use the typeconst ctype*. Is this made intentionally?bli_rntm_printfunction is not exported?bli_info_get_enable_stay_auto_initfunction is declared, but not defined.Note: this is a refreshed version of my PR #838 closed that differs as follows: