JuliaPlots/Plots.jl

improvements for plotattr

Open

#676 opened on Feb 9, 2017

View on GitHub
 (0 comments) (2 reactions) (0 assignees)Julia (1,943 stars) (381 forks)batch import
good first issuevizcon

Description

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)

Contributor guide

Tech stack
None
Domain
documentationdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JuliaPlots.jl codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
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.
improvements for plotattr · JuliaPlots/Plots.jl#676 | Good First Issue