Skip to content

Conversation

@cgiachalis
Copy link
Contributor

@cgiachalis cgiachalis commented May 28, 2025

Metadata section is missing three functions. This is because within pkgdown yaml the topic matching lists all functions with suffix "metadata" e.g., ends_with("metadata"), but not all metadata functions follow that pattern.

library(tiledb)

fns_tiledb <- apropos("^tiledb")

fns_metadata <- fns_tiledb[grepl("metadata", fns_tiledb, fixed = TRUE)]

fns_metadata[!endsWith(fns_metadata, "metadata")]
#> [1] "tiledb_fragment_info_get_unconsolidated_metadata_num"
#> [2] "tiledb_group_get_metadata_from_index"                
#> [3] "tiledb_group_metadata_num"

This PR fixes the issue by using matches("metadata").

Another two points you might want to reflect:

  1. naming consistency e.g., tiledb_num_metadata() vs tiledb_group_metadata_num() (it's this example that triggered the PR)

  2. pkgdown reference index builds its contents using selectors excessively even for individual functions; as a result it creates cluttered sections on some occasions, see Array section

@ihnorton ihnorton requested a review from johnkerl May 29, 2025 12:51
@cgiachalis cgiachalis force-pushed the cg/pkgdown-update-metadata-section branch from 8a83ac1 to 2f197c6 Compare June 9, 2025 15:44
@cgiachalis cgiachalis requested a review from johnkerl June 9, 2025 15:49
Copy link
Contributor

@johnkerl johnkerl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cgiachalis !

@johnkerl johnkerl merged commit eeb685e into TileDB-Inc:main Jun 9, 2025
7 checks passed
@cgiachalis
Copy link
Contributor Author

Thanks!

@cgiachalis cgiachalis deleted the cg/pkgdown-update-metadata-section branch June 17, 2025 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants