mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-10-17 22:07:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Generate API reference for options documentation (#5072)

Browse source 
## Summary

Generates Markdown from the `OptionsMetadata`, following the same
strategy as in Ruff.

## Test Plan

`cargo dev generate-options-reference`
This commit is contained in:
Charlie Marsh 2024-07-15 15:48:40 -04:00 • committed by GitHub
parent 1b1eba12c7
commit 6275b54d51
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 343 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/uv-macros/src/options_metadata.rs
View file

@ -91,8 +91,8 @@ pub(crate) fn derive_impl(input: DeriveInput) -> syn::Result<TokenStream> {
Ok(quote! {
#[automatically_derived]
impl crate::options_base::OptionsMetadata for #ident {
fn record(visit: &mut dyn crate::options_base::Visit) {
impl uv_options_metadata::OptionsMetadata for #ident {
fn record(visit: &mut dyn uv_options_metadata::Visit) {
#(#output);*
}
@ -130,7 +130,7 @@ fn handle_option_group(field: &Field) -> syn::Result<proc_macro2::TokenStream> {
let kebab_name = LitStr::new(&ident.to_string().replace('_', "-"), ident.span());
Ok(quote_spanned!(
ident.span() => (visit.record_set(#kebab_name, crate::options_base::OptionSet::of::<#path>()))
ident.span() => (visit.record_set(#kebab_name, uv_options_metadata::OptionSet::of::<#path>()))
))
}
_ => Err(syn::Error::new(
@ -219,14 +219,14 @@ fn handle_option(field: &Field, attr: &Attribute) -> syn::Result<proc_macro2::To
let note = quote_option(deprecated.note);
let since = quote_option(deprecated.since);
quote!(Some(crate::options_base::Deprecated { since: #since, message: #note }))
quote!(Some(uv_options_metadata::Deprecated { since: #since, message: #note }))
} else {
quote!(None)
};
Ok(quote_spanned!(
ident.span() => {
visit.record_field(#kebab_name, crate::options_base::OptionField{
visit.record_field(#kebab_name, uv_options_metadata::OptionField{
doc: &#doc,
default: &#default,
value_type: &#value_type,