Skip to content

Commit d50e5bc

Browse files
alshanalshan
committed
Updates docs.
1 parent 9368a6a commit d50e5bc

File tree

5 files changed

+58
-93
lines changed

5 files changed

+58
-93
lines changed

‎CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
66
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [2.0.1] - 2021-04-?? (coming)
8+
## [2.0.1] - 2021-04-19
99

1010
### Changed
1111

12+
- **[BREAKING CHANGE]**: The **groupId** of all maven artifacts is now **"org.jetbrains.lets-plot"** (was "
13+
org.jetbrains.lets-plot-kotlin")
1214
- Built with Lets-Plot v2.0.2 (was v2.0.2).
13-
- All "snake_case" symbols were deprecated and replaced with equivalent "camelCase"
15+
- All **snake_case** symbols were deprecated and replaced with equivalent **camelCase**
1416
symbols [[#53](https://github.com/JetBrains/lets-plot-kotlin/discussions/53)].
1517
- Maven artifacts published to [Maven Central](https://search.maven.org/search?q=lets-plot) (due to shutting down
1618
of [Bintray, JCenter](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/))
17-
- **[!]** The **groupId** of all maven artifacts is now **org.jetbrains.lets-plot** (before was "
18-
org.jetbrains.lets-plot-kotlin")
1919

2020
## [1.3.0] - 2021-03-22
2121

‎README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
- [Tooltip customization](#tooltip-customization)
4646
- [GeoTools support](#geotools)
4747

48-
- [What is new in 1.3.0](#new)
48+
- [What is new in 2.0.1](#new)
4949
- [Change log](#change_log)
5050
- [License](#license)
5151

@@ -245,30 +245,15 @@ Learn more: [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blo
245245

246246
<a id="new"></a>
247247

248-
## What is new in 1.3.0
249-
250-
- Improved faceting:
251-
- New `facet_wrap()` function.
252-
- Formatting and ordering options.
253-
254-
See: [Facets demo](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets.ipynb)
255-
.
256-
257-
- Formatting tick labels on X/Y axis.
258-
259-
Example:
260-
```Kotlin
261-
scale_x_datetime(format="%b %Y")
262-
scale_x_continuous(format="is {.2f}")
263-
```
264-
265-
Demo: [Formatting demo](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/formatting_axes_etc.ipynb)
266-
267-
See also: [Formatting](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
268-
269-
- The`show()` method, by default, now opens a Swing frame showing the
270-
plot. [[#51](https://github.com/JetBrains/lets-plot-kotlin/issues/51)]
248+
## What is new in 2.0.1
271249

250+
- **[BREAKING CHANGE]**: The **groupId** of all maven artifacts is now **"org.jetbrains.lets-plot"** (was "
251+
org.jetbrains.lets-plot-kotlin")
252+
This was the reason for increasing of the `major` version.
253+
- All **snake_case** symbols were deprecated and replaced with equivalent **camelCase**
254+
symbols [[#53](https://github.com/JetBrains/lets-plot-kotlin/discussions/53)].
255+
- Maven artifacts published to [Maven Central](https://search.maven.org/search?q=lets-plot) (due to shutting down
256+
of [Bintray, JCenter](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/))
272257

273258
- Other improvements and fixes -
274259
see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md)

‎README_DEV.md

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,17 @@ It also offers a choice between [JavaFX](https://en.wikipedia.org/wiki/JavaFX) g
2828
- `lets-plot-common`
2929
- `lets-plot-batik` or `lets-plot-jfx` (choose one)
3030

31-
[ ![Download](https://api.bintray.com/packages/jetbrains/lets-plot-maven/lets-plot-jars/images/download.svg)](https://bintray.com/jetbrains/lets-plot-maven/lets-plot-jars/_latestVersion)
32-
31+
[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.lets-plot/lets-plot-common?color=blue&label=Maven%20Central)](https://search.maven.org/search?q=lets-plot)
3332

3433
#### Lets-Plot Kotlin API artifact (published by this project)
3534

3635
- `lets-plot-kotlin-api`
3736

38-
[ ![Download](https://api.bintray.com/packages/jetbrains/lets-plot-maven/lets-plot-kotlin-jars/images/download.svg)](https://bintray.com/jetbrains/lets-plot-maven/lets-plot-kotlin-jars/_latestVersion)
39-
37+
[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.lets-plot/lets-plot-kotlin-api?color=blue&label=Maven%20Central)](https://search.maven.org/search?q=lets-plot-kotlin)
4038

4139
#### Project dependencies
4240

43-
All artifacts are available at [jcenter](https://bintray.com/bintray/jcenter) Maven repository.
41+
All artifacts are available at [Maven Central](https://search.maven.org/search?q=lets-plot).
4442

4543
The following is an example fragment of a Gradle project that uses Lets-Plot Kotlin API and Apache Batik rendering:
4644

@@ -49,46 +47,16 @@ dependencies {
4947
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
5048
implementation "org.jetbrains.lets-plot:lets-plot-batik:<lib version>"
5149
api "org.jetbrains.lets-plot:lets-plot-common:<lib version>"
52-
api "org.jetbrains.lets-plot-kotlin:lets-plot-kotlin-api:<api version>"
50+
api "org.jetbrains.lets-plot:lets-plot-kotlin-api:<api version>"
5351
}
5452
```
5553

5654
```groovy
5755
repositories {
58-
jcenter()
56+
mavenCentral()
5957
}
6058
```
6159

62-
Development artifacts are not linked to [jcenter](https://bintray.com/bintray/jcenter) and can be only used via
63-
a direct link to the `lets-plot-maven` repository:
64-
65-
```groovy
66-
repositories {
67-
maven {
68-
url "https://jetbrains.bintray.com/lets-plot-maven"
69-
}
70-
}
71-
```
72-
73-
<table>
74-
<tr>
75-
<td>Lets-Plot Kotlin API snapshots</td>
76-
<td>
77-
<a href="https://bintray.com/jetbrains/lets-plot-maven/lets-plot-kotlin-jars-dev/_latestVersion"/>
78-
<img src="https://api.bintray.com/packages/jetbrains/lets-plot-maven/lets-plot-kotlin-jars-dev/images/download.svg"/>
79-
</td>
80-
</tr>
81-
<tr>
82-
<td>Lets-Plot library snapshots</td>
83-
<td>
84-
<a href="https://bintray.com/jetbrains/lets-plot-maven/lets-plot-jars-dev/_latestVersion"/>
85-
<img src="https://api.bintray.com/packages/jetbrains/lets-plot-maven/lets-plot-jars-dev/images/download.svg"/>
86-
</td>
87-
</tr>
88-
</table>
89-
90-
91-
9260
#### An example of a **minimal JVM-based** application
9361

9462
- Using Apache Batik:
@@ -112,7 +80,8 @@ org.jetbrains.lets-plot:lets-plot-common:<lib version>
11280
org.jetbrains.lets-plot-kotlin:lets-plot-kotlin-api:<api version>
11381
```
11482

115-
#### Implement interface `jetbrains.letsPlot.FrontendContext` like:
83+
#### Implement the `jetbrains.letsPlot.FrontendContext` interface:
84+
11685
```
11786
import jetbrains.datalore.plot.PlotHtmlHelper
11887
import jetbrains.letsPlot.FrontendContext
@@ -132,7 +101,7 @@ Load `Lets-Plot` JS library to the user agent:
132101
import jetbrains.datalore.plot.PlotHtmlHelper
133102
import jetbrains.datalore.plot.PlotHtmlHelper.scriptUrl
134103
135-
val ver = .. // JS library version, for example: "1.1.dev2"
104+
val ver = .. // JS library version, for example: "1.2.3"
136105
val html:String = PlotHtmlHelper.getDynamicConfigureHtml(scriptUrl(ver), false)
137106
// include `configure html` in your document ...
138107
```

‎RELEASE.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
11
## Releasing the project
22

3-
43
### Make version
54

65
##### 1. Update CHANGELOG.md file
76

8-
##### 2. Set release version in 'build.gradle'
7+
##### 2. Set release version in 'build.gradle'
8+
9+
- remove _"-alphaN"_ qualifier for the 'version' property.
10+
11+
##### 3. Build and release JVM artifacts to Maven Central
12+
13+
a) Upload to the Nexus staging repository:
14+
15+
- `./gradlew publishLetsPlotKotlinApiPublicationToMavenRepository`
16+
- `./gradlew publishLetsPlotKotlinApiKernelPublicationToMavenRepository`
17+
- `./gradlew publishLetsPlotKotlinGeoToolsPublicationToMavenRepository`
18+
19+
b) Publish all artifacts to the Nexus "Releases" repository (from the staging):
20+
21+
- `./gradlew closeAndReleaseRepository`
922

10-
- remove _"-alphaN"_ qualifier for the 'version' property.
11-
12-
##### 3. Build and upload JVM artifacts to Bintray/JCenter
23+
Note: PGP signature is required for publishing.
1324

14-
- `./gradlew :plot-api:bintrayUpload`
15-
- `./gradlew :geotools:bintrayUpload`
25+
See:
1626

17-
Note that release versions will be uploaded to the `lets-plot-kotlin-jars` package.
18-
Any 'alpha' version will be uploaded to the `lets-plot-kotlin-jars-dev` package.
27+
- https://central.sonatype.org/pages/working-with-pgp-signatures.html
28+
- [build_settings.template.yml](https://github.com/JetBrains/lets-plot-kotlin/blob/master/build_settings.template.yml)
1929

2030
##### 4. Prepare to the next dev cycle
2131

‎docs/examples.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,55 +27,55 @@ Try the following tutorials and examples to learn and evaluate various features
2727
<a id="geoms_n_stats"></a>
2828
#### Geoms and Stats
2929

30-
`geom_histogram, geom_density, geom_vline, geom_freqpoly, geom_boxplot`:
30+
`geomHistogram, geomDensity, geomVLine, geomFreqpoly, geomBoxplot`:
3131

3232
[distributions.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/distributions.ipynb)
3333

34-
`geom_errorbar, geom_line, geom_point, geom_bar, geom_crossbar, geom_linerange, geom_pointrange`:
34+
`geomErrorBar, geomLine, geomPoint, geomBar, geomCrossbar, geomLineRange, geomPointRange`:
3535

3636
[error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
3737

38-
`geom_point, geom_smooth (stat_smooth)`:
38+
`geomPoint, geomSmooth (statSmooth)`:
3939

4040
[scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
4141

42-
[geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
42+
[geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
4343

44-
`geom_density2d, geom_density2df, geom_bin2d, geom_polygon, geom_point` :
44+
`geomDensity2D, geomDensity2DFilled, geomBin2D, geomPolygon, geomPoint` :
4545

4646
[density_2d.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/density_2d.ipynb)
4747

48-
`geom_tile, geom_contour, geom_polygon (Stat.contour), geom_contourf` :
48+
`geomTile, geomContour, geomPolygon (Stat.contour), geomContourFilled` :
4949

5050
[contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
5151

52-
`geom_text`, label format
52+
`geomText`, label format
5353

5454
[label_format.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/label_format.ipynb)
5555

5656

5757
<a id="pos"></a>
5858
#### Position Adjustment
5959

60-
* `position_dodge` : [error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
61-
* `position_jitter` : [scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
60+
* `positionDodge` : [error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
61+
* `positionJitter` : [scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
6262

6363

6464
<a id="scales"></a>
6565
#### Scales
6666

67-
* `scale_color_manual, scale_fill_manual` :
68-
[error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
69-
* `scale_x_continuous, scale_shape_manual` :
70-
[scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
71-
* `scale_color_gradient` : [density_2d.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/density_2d.ipynb)
72-
* `scale_fill_hue, scale_fill_grey, scale_color_gradient` : [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
67+
* `scaleColorManual, scaleFillManual` :
68+
[error_bars.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/error_bars.ipynb)
69+
* `scaleXContinuous, scaleShapeManual` :
70+
[scatter_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/scatter_plot.ipynb)
71+
* `scaleColorGradient` : [density_2d.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/density_2d.ipynb)
72+
* `scaleFillHue, scaleFillGrey, scaleColorGradient` : [contours.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/contours.ipynb)
7373

7474

7575
<a id="facets"></a>
7676
#### Facets
7777

78-
* `facet_grid(), facet_wrap()`:
78+
* `facetGrid(), facetWrap()`:
7979
[facets.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/facets.ipynb)
8080

8181
<a id="ggbunch"></a>
@@ -95,7 +95,8 @@ A simple utility which you can use to arrange plots in a regular grid.
9595
* [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
9696

9797
<a id="as_discrete"></a>
98-
#### `as_discrete()` function
98+
99+
#### `asDiscrete()` function
99100

100101
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
101102

0 commit comments

Comments
 (0)