Skip to content

Commit

Permalink
Add TODO about using api-custom for in-dev symbols
Browse files Browse the repository at this point in the history
  • Loading branch information
Bromeon committed Nov 23, 2024
1 parent 69b5c45 commit 2a83b54
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions documentation/put.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ case $repo in
;;
"gdext")
mainCrate="godot"

# TODO consider using `api-custom` + running engine; or alternatively a new `api-custom-json` reading extension_api.json directly.
# This would allow #[cfg(since_api = "4.x")] to work also for in-dev symbols, while those are currently hidden.
#
# Probably not directly helpful, but in case: following code can be used to figure out which `api-4-x` feature is the highest available.
# availableFeatures=$(cargo read-manifest -p godot/Cargo.toml | jq -r '.features | keys[]')
# highestApiFeature=$(echo "$availableFeatures" | grep -oP '^api-4-\d+$' | sort -V | tail -n 1)

# `experimental-godot-api` is needed to allow "only available in ..." labels with #[doc(cfg)].
# Could add experimental-threads in the future, but for now it's unstable and possibly more confusing.
features="--features experimental-godot-api"
Expand Down

0 comments on commit 2a83b54

Please sign in to comment.