apache / apache/datafusion

doc: create macros to hide logo/icon

Open
#14,796 9 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Rust
Stars
9.3k
Forks
2.4k
Avg merge
3d 7h
Merged PRs (30d)
344

Description

thanks @mbrobbel WDYT if we create our own proc macro in `datafusion/macros`?

So the proc macro will eventually generate the inner `doc!`, so we can improve readability and have logo urls in a single place

_Originally posted by @comphead in https://github.com/apache/datafusion/pull/14746#pullrequestreview-2627305157_

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing code under `datafusion/macros` and the `doc!` usage referenced in the issue. Determine how the proc macro should hide the logo and icon while keeping logo URLs centralized. Done means the macro generates the intended inner documentation without requiring repeated logo or icon details.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.