zed_extension_api: Add a short explanation of `repo` format (#21824)

strowk and Marshall Bowers created 1 year ago

Improved extension api documentation for latest_github_release function

Release Notes:

- N/A

---------

Co-authored-by: Marshall Bowers <[e-mail]>

Change summary

crates/extension_api/wit/since_v0.2.0/github.wit | 2 ++
1 file changed, 2 insertions(+)

Detailed changes

crates/extension_api/wit/since_v0.2.0/github.wit

@@ -24,6 +24,8 @@ interface github {
     }
 
     /// Returns the latest release for the given GitHub repository.
+    ///
+    /// Takes repo as a string in the form "<owner-name>/<repo-name>", for example: "zed-industries/zed".
     latest-github-release: func(repo: string, options: github-release-options) -> result<github-release, string>;
 
     /// Returns the GitHub release with the specified tag name for the given GitHub repository.