Skip to content

Commit

Permalink
Update readme to recommend static string references for scope names
Browse files Browse the repository at this point in the history
  • Loading branch information
aclysma committed Oct 14, 2024
1 parent 0eaa454 commit 1c5dfd2
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Currently, there's just six macros:
* `profiling::scope!(name: &str, [tag: &str])`
* name: scopes will appear in the profiler under this name
* tag: optional extra data
* For maximum compatibility, you are **strongly** recommended to use literal strings for the name. Some backends require
static lifetime string references and some require literal strings.
* `#[profiling::function]`
* procmacro placed on a function to quickly wrap it in a scope using the function name
* `#[profiling::all_functions]`
Expand Down

0 comments on commit 1c5dfd2

Please sign in to comment.