Clarify scatter plot support via alias & example(s)

オープン
#160 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
68/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python

調査の方向性

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時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NCAS-CMS/cf-plot のほかの issue

NCAS-CMS/cf-plot の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。