Clarify scatter plot support via alias & example(s)

未关闭
  • 哪里不对？
#160 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
data-visualization

调研方向

Read the lineplot implementation and docstring to see how lines=False and keyword arguments are handled, then find the documentation examples for plotting. Add the scatter alias, clarify the docstring, and include a scatter plot example. Done when the alias produces a scatter-only plot and the documentation shows how to use it.

由索引模型根据 Issue 内容生成。

描述

enhancement

A user requested that we support, natively in cf-plot, a means to produce a scatter plot. This is a natural complement to a lineplot that scientists and data/software technical professionals etc. often want to create, so is a major plot type to support.

It happens that we do support this but in a way that isn't obvious: one must call cfp.lineplot with lines=False set. So I suggest we do the following:

  • update the lineplot docstring to clarify that scatter plots are also in scope with that function, ideally with some 'example' code snippets at the end;
  • add a plotting method scatter which calls lineplot with all of the equivalent kwargs but with lines=False set so it creates not a line (with optional scatter-like markers) plot but a scatter-only plot;
  • add an explicit example to the documentation to showcase the means to create a scatter plot.
主要语言
Python
星标
21
派生
11
平均合并
2 天 21 小时
30 天内合并 PR
7

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

NCAS-CMS/cf-plot 的其他 Issue

查看 NCAS-CMS/cf-plot 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。