Adding docstring for the Allocs #53559
Conversation
|
@stevengj Hello, |
|
Welcome @mariam606 |
|
|
||
| # Fields | ||
| - `data::Ptr{BTElement}`: A pointer to the beginning of the backtrace data array. | ||
| - `size::Csize_t`: The number of elements in the backtrace data array. |
There was a problem hiding this comment.
Not clear that we want to document these internal fields — this is not something a user should touch?
Better to document what can be done with this data structure via documented functions, e.g. presumably it is returned by catch_backtrace() and can be used with rethrow and show_backtrace? (I'm just guessing, should be checked.)
There was a problem hiding this comment.
If this is an undocumented internal type, then it is pretty much only for people who are reading the source code, in which case a docstring listing the fields isn't very useful.
| It includes information about the type of the allocated object, the backtrace associated with the allocation event, | ||
| the size of the allocation, the task in which the allocation occurred, and a timestamp marking the allocation time. | ||
| This struct is designed to closely mirror the corresponding C structure used internally by Julia, | ||
| making it easier to process allocation data in Julia's environment. |
There was a problem hiding this comment.
Again, would be good to link functions that return a RawAlloc or where you get it, and what functions it can be used with?
|
#52725 is only about adding docstrings for public / exported symbols, which in this case is only the That is, to address #52725 you need to add a docstring at the very top of the file, for You don't need to add docstrings for undocumented internal types and methods, although good documentation is welcome. |
This is a part of the issue #52725
This PR adds docstring for the Profile: Allocs.