Skip to content

Fix errors and typos in some docs#838

Closed
jip wants to merge 14 commits intoflame:masterfrom
jip:fix
Closed

Fix errors and typos in some docs#838
jip wants to merge 14 commits intoflame:masterfrom
jip:fix

Conversation

@jip
Copy link
Copy Markdown
Contributor

@jip jip commented Jan 8, 2025

Details:

  • fix errors and typos,
  • format according to coding style guide,
  • unify a bit the formatting and content in docs/BLIS*API.md,
  • sync the content in docs/BLIS*API.md with the current code base.

BTW, questions:

  • There is one discrepancy in function signatures: bli_?print[vm] use the type const void* for x parameter, but bli_?fprint[vm] use the type const ctype*. Is this made intentionally?
  • Why bli_rntm_print function is not exported?
  • A bli_info_get_enable_stay_auto_init function is declared, but not defined.

jip added 14 commits January 8, 2025 12:27
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
'is_eq' parameter must has no 'const' qualifier in bli_eqsc and bli_eq[vm] functions.
Fixes the commit 69feae7.
Recreate the omitting fragment.
Recreate one more omitting fragment (fix previous commit).
@jip
Copy link
Copy Markdown
Contributor Author

jip commented Jan 20, 2025

I've tried to rebase my origin/fix branch to current upstream/master, but failed. Should I drop this PR and try to make a new one rebased properly?

@jip jip closed this Jan 20, 2025
@jip jip deleted the fix branch January 20, 2025 05:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant