Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Stdlib: Fill descriptions for stdlib Builtin interfaces #5304

Open
jkwak-work opened this issue Oct 15, 2024 · 4 comments · May be fixed by #5374
Open

Stdlib: Fill descriptions for stdlib Builtin interfaces #5304

jkwak-work opened this issue Oct 15, 2024 · 4 comments · May be fixed by #5374
Assignees
@jkwak-work
Labels
goal:forward looking Feature needed at a later date, not connected to a specific use case. kind:documentation areas where we can improve documentation in codebase

Comments

@jkwak-work
Copy link
Collaborator

jkwak-work commented Oct 15, 2024 •
edited
Loading

Currently the doc generation tool reports that 682 descriptions are missing, which is about 86%.

We need to fill in the descriptions preferably in a priority order.

  1. We need clear descriptions for interface, because interfaces don't have implementations and they are nothing without documentation.
@jkwak-work jkwak-work self-assigned this Oct 15, 2024
@jkwak-work jkwak-work added kind:documentation areas where we can improve documentation in codebase goal:forward looking Feature needed at a later date, not connected to a specific use case. labels Oct 15, 2024
@bmillsNV bmillsNV changed the title Fill descriptions for stdlib intrinsics Stdlib: Fill descriptions for stdlib intrinsics Oct 15, 2024
@jkwak-work jkwak-work changed the title Stdlib: Fill descriptions for stdlib intrinsics Stdlib: Fill descriptions for stdlib builtin interfaces Oct 15, 2024
@bmillsNV bmillsNV changed the title Stdlib: Fill descriptions for stdlib builtin interfaces Stdlib: Fill descriptions for stdlib Builtin interfaces Oct 15, 2024
@jkwak-work jkwak-work mentioned this issue Oct 21, 2024
Merged
@jkwak-work
Copy link
Collaborator Author

I am leaving related links for this task.

HTML result page: https://shader-slang.com/stdlib-reference/interfaces/index.html
Undocumented items: https://github.com/shader-slang/stdlib-reference/blob/main/summary.txt

@jkwak-work
Copy link
Collaborator Author

Currently following items need to be documented,

  • IArithmetic.add
  • IArithmetic.div
  • IArithmetic.mod
  • IArithmetic.mul
  • IArithmetic.neg
  • IArithmetic.sub
  • IArray.subscript
  • IBufferDataLayout
  • IDefaultInitializable.init
  • IDifferentiable.dadd
  • IDifferentiable.dmul
  • IDifferentiable.dzero
  • IDifferentiableFunc<TR, each TP>
  • IDifferentiableFunc<TR, each TP>.operator()
  • IDifferentiableMutatingFunc<TR, each TP>
  • IDifferentiableMutatingFunc<TR, each TP>.operator()
  • IDifferentiablePtrType
  • IFunc<TR, each TP>
  • IFunc<TR, each TP>.operator()
  • IInteger.init
  • IInteger.toInt
  • IInteger.toInt64
  • IInteger.toUInt
  • IInteger.toUInt64
  • ILogical.and
  • ILogical.bitAnd
  • ILogical.bitNot
  • ILogical.bitOr
  • ILogical.bitXor
  • ILogical.init
  • ILogical.not
  • ILogical.or
  • ILogical.shl
  • ILogical.shr
  • IMutatingFunc<TR, each TP>
  • IMutatingFunc<TR, each TP>.operator()
  • IRWArray.subscript
  • IRangedValue.maxValue
  • IRangedValue.minValue

@jkwak-work jkwak-work linked a pull request Oct 22, 2024 that will close this issue
Open
@jkwak-work
Copy link
Collaborator Author

jkwak-work commented Oct 22, 2024 •
edited
Loading

@bmillsNV , am I allowed to use Coverall for stdlib documentation?
I gave a try and it worked very well, but I like to double check if I am allowed to use it for Slang.

@bmillsNV
Copy link
Collaborator

@jkwak-work yes you can use coveralls here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jkwak-work jkwak-work

Labels
goal:forward looking Feature needed at a later date, not connected to a specific use case. kind:documentation areas where we can improve documentation in codebase
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document the interfaces in the core module jkwak-work/slang
2 participants
@jkwak-work @bmillsNV