improvements for plotattr · JuliaPlots/Plots.jl#676

(0 comments) (2 reactions) (0 assignees)Julia (1,943 stars) (381 forks)batch import

good first issuevizcon

説明

I am opening this to get comments and ideas on improvements of plotattr that looks up plot keywords from the console (added here #674). Here are some ideas:

write proper doc-strings for the exported functions
make descriptions searchable, e.g. by adding a search keyword to the no-positional-arguments method of plotattr that matches any regular expression or string to descriptions
identifies 'magic' arguments and how to call them
add some bonus info for certain attributes... like a more complete descriptions of the core series types, etc. (copied from @tbreloff's comment on the PR)
make it possible to search 'xlims' and get 'lims' (and other such cases)

コントリビューターガイド

技術スタック: なし
領域: documentationdeveloper experience
Issue 種別: feature
難度: 3
推定時間: 1-2 days
活動状況: stale
明確さ: mostly clear
前提条件: JuliaPlots.jl codebase
初心者向け度: 30
調査方針: The issue outlines remaining tasks for plotattr: add a search keyword accepting regex, identify magic arguments, add bonus info, and enable fuzzy matching like 'xlims' to find 'lims'. The current implementation was introduced in PR #674; look at the plotattr function in the Plots.jl source (likely under src/) to understand its structure. Implement a search feature that matches descriptions, and consider using regex for flexibility. For the fuzzy matching, explore synonyms or substring matching.