apache / apache/arrow-rs-object-store

get_object_store() not exported

Open
#448 2 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Rust
Stars
322
Forks
212
Avg merge
5d 2h
Merged PRs (30d)
10

Description

**Describe the bug**

The doc examples for object_store all reference a function `get_object_store()`. This function is not exported nor documented.

**To Reproduce**

1. Navigate to https://docs.rs/object_store observe the use of `get_object_store()` in the doc examples (first instance under "List objects")
2. Search for get_object_store() https://docs.rs/object_store/latest/object_store/index.html?search=get_object_store#conditional-put

**Expected behavior**

The function is documented and exported. Or, the function is not used. Or, the function is defined in the doc examples.

**Additional context**

Contributor guide

Open the contributing guide

Research direction

Start with the object_store documentation examples linked in the issue and search the crate for get_object_store(). Confirm whether the examples reference an unavailable function; done means the examples no longer contain an unresolved reference and the chosen behavior is reflected in the documentation or exports.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.