Skip to content

Commit ff8ecab

Browse files
Zoraiyotcbegley
andauthored
Fix: Dead link and deprecation warnings (#1122)
* Fix: Link and deprecation warning * Update: uniform format for deprecation warnings * Additional updates to release docs * Lint / format --------- Co-authored-by: tcbegley <tomcbegley@gmail.com>
1 parent 68a6dea commit ff8ecab

File tree

12 files changed

+44
-45
lines changed

12 files changed

+44
-45
lines changed

docs/how-to-release.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# How to release dash-bootstrap-components
22

3-
This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with an [`invoke`](http://docs.pyinvoke.org/en/latest/getting_started.html>) task file. You will need `invoke` and `semver` installed.
3+
This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with [`just`](https://github.com/casey/just)
44

5-
- Run `invoke prerelease <version>`, where `version` is the version number of the release candidate. If you are aiming to release version `0.0.7`, this will be `0.0.7-rc1`. This will automatically bump the version numbers and push a release branch to GitHub.
5+
- Run `just prerelease <version>`, where `version` is the version number of the release candidate. If you are aiming to release version `0.0.7`, this will be `0.0.7-rc1`. This will automatically bump the version numbers and push a release branch to GitHub.
66

77
- Create a pull request with this branch, and document changes in the release in the comment of your pull request. The title and comment of the pull request are used by GitHub Actions to make the release on GitHub. See the other releases or the [changelog](https://dash-bootstrap-components.opensource.faculty.ai/changelog/) for previous release summaries.
88

99
- Merge the pull request. This will trigger a GitHub Action that will build the package and upload to PyPI.
1010

11-
- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`. It's best to verify the installation on a clean virtual machine (rather than just in a new environment) since installation is more complex than for pure Python packages.
11+
- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`.
1212

1313
- If the manual installation tests failed, fix the issue and repeat the previous steps with `rc2` etc. If installing worked, proceed to the next steps.
1414

15-
- Run `invoke release <version>`, where `version` is the version number of the release (e.g. `0.7.0`). This will push a release branch to GitHub.
15+
- Run `just release <version>`, where `version` is the version number of the release (e.g. `0.0.7`). This will push a release branch to GitHub.
1616

1717
- As before, open a pull request and use the title and comment to document changes to the package. When the pull request is merged GitHub Actions will build the packages and upload it to PyPI.
1818

@@ -23,5 +23,5 @@ This is a set of instructions for releasing _dash-bootstrap-components_. The rel
2323
The documentation is currently hosted on Heroku. To push documentation updates:
2424

2525
```sh
26-
invoke documentation
26+
just deploy-docs
2727
```

pyproject.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ authors = [
1414
]
1515
maintainers = [{ name = "Tom Begley", email = "tomcbegley@gmail.com" }]
1616
requires-python = ">=3.9"
17-
dependencies = [
18-
"dash>=3.0.3",
19-
]
17+
dependencies = ["dash>=3.0.3"]
2018
classifiers = [
2119
"Framework :: Dash",
2220
"License :: OSI Approved :: Apache Software License",

src/components/breadcrumb/Breadcrumb.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ Breadcrumb.propTypes = {
112112
key: PropTypes.string,
113113

114114
/**
115-
* **DEPRECATED** - Use class_name instead.
115+
* **DEPRECATED** Use `class_name` instead.
116116
*
117117
* Additional CSS classes to apply to the Breadcrumb.
118118
*/
119119
className: PropTypes.string,
120120

121121
/**
122-
* **DEPRECATED** - use item_class_name instead.
122+
* **DEPRECATED** Use `item_class_name` instead.
123123
*
124124
* Additional CSS classes to apply to each item.
125125
*/

src/components/carousel/Carousel.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,8 @@ Carousel.propTypes = {
231231
/**
232232
* **DEPRECATED** Use `class_name` instead.
233233
*
234-
* efines the className of the carousel container. Additional CSS classes to apply to the Carousel.
234+
* Defines the className of the carousel container. Additional CSS classes
235+
* to apply to the Carousel.
235236
*/
236237
className: PropTypes.string,
237238

src/components/dropdownmenu/DropdownMenu.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ DropdownMenu.propTypes = {
206206
/**
207207
* **DEPRECATED** Use `toggle_class_name` instead.
208208
*
209-
* Additional CSS classes to apply to the DropdownMenu The classes
209+
* Additional CSS classes to apply to the DropdownMenu. The classes
210210
* specified with this prop will be applied to the DropdownMenu toggle.
211211
*/
212212
toggleClassName: PropTypes.string,

src/components/input/Textarea.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -373,49 +373,49 @@ Textarea.propTypes = {
373373
className: PropTypes.string,
374374

375375
/**
376-
* **DEPRECATED** Use `accesskey` instead
376+
* **DEPRECATED** Use `accesskey` instead.
377377
*
378378
* Defines a keyboard shortcut to activate or add focus to the element.
379379
*/
380380
accessKey: PropTypes.string,
381381

382382
/**
383-
* **DEPRECATED** Use `autofocus` instead
383+
* **DEPRECATED** Use `autofocus` instead.
384384
*
385385
* The element should be automatically focused after the page loaded.
386386
*/
387387
autoFocus: PropTypes.string,
388388

389389
/**
390-
* **DEPRECATED** Use `contenteditable` instead
390+
* **DEPRECATED** Use `contenteditable` instead.
391391
*
392392
* Indicates whether the element's content is editable.
393393
*/
394394
contentEditable: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
395395

396396
/**
397-
* **DEPRECATED** Use `contextmenu` instead
397+
* **DEPRECATED** Use `contextmenu` instead.
398398
*
399399
* Defines the ID of a <menu> element which will serve as the element's context menu.
400400
*/
401401
contextMenu: PropTypes.string,
402402

403403
/**
404-
* **DEPRECATED** Use `maxlength` instead
404+
* **DEPRECATED** Use `maxlength` instead.
405405
*
406406
* Defines the maximum number of characters allowed in the element.
407407
*/
408408
maxLength: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
409409

410410
/**
411-
* **DEPRECATED** Use `minlength` instead
411+
* **DEPRECATED** Use `minlength` instead.
412412
*
413413
* Defines the minimum number of characters allowed in the element.
414414
*/
415415
minLength: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
416416

417417
/**
418-
* **DEPRECATED** Use `readonly` instead
418+
* **DEPRECATED** Use `readonly` instead.
419419
*
420420
* Indicates whether the element can be edited.
421421
*/
@@ -425,7 +425,7 @@ Textarea.propTypes = {
425425
]),
426426

427427
/**
428-
* **DEPRECATED** Use `spellcheck` instead
428+
* **DEPRECATED** Use `spellcheck` instead.
429429
*
430430
* Indicates whether spell checking is allowed for the element.
431431
*/
@@ -436,7 +436,7 @@ Textarea.propTypes = {
436436
]),
437437

438438
/**
439-
* **DEPRECATED** Use `tabindex` instead
439+
* **DEPRECATED** Use `tabindex` instead.
440440
*
441441
* Overrides the browser's default tab order and follows the one specified instead.
442442
*/

src/components/modal/Modal.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -206,68 +206,68 @@ Modal.propTypes = {
206206
/**
207207
* **DEPRECATED** Use `dialog_style` instead.
208208
*
209-
* Inline CSS styles to apply to the dialog
209+
* Inline CSS styles to apply to the dialog.
210210
*/
211211
dialogStyle: PropTypes.object,
212212

213213
/**
214214
* **DEPRECATED** Use `content_style` instead.
215215
*
216-
* Inline CSS styles to apply to the content
216+
* Inline CSS styles to apply to the content.
217217
*/
218218
contentStyle: PropTypes.object,
219219

220220
/**
221-
* **DEPRECATED** Use `content_style` instead.
221+
* **DEPRECATED** Use `backdrop_style` instead.
222222
*
223-
* Inline CSS styles to apply to the backdrop
223+
* Inline CSS styles to apply to the backdrop.
224224
*/
225225
backdropStyle: PropTypes.object,
226226

227227
/**
228228
* **DEPRECATED** Use `class_name` instead.
229229
*
230-
* Additional CSS classes to apply to the Modal
230+
* Additional CSS classes to apply to the Modal.
231231
*/
232232
className: PropTypes.string,
233233

234234
/**
235-
* **DEPRECATED** Use `backdrop_class_name` instead
235+
* **DEPRECATED** Use `backdrop_class_name` instead.
236236
*
237237
* Additional CSS classes to apply to the modal-backdrop.
238238
*/
239239
backdropClassName: PropTypes.string,
240240

241241
/**
242-
* **DEPRECATED** Use `content_class_name` instead
242+
* **DEPRECATED** Use `content_class_name` instead.
243243
*
244244
* Additional CSS classes to apply to the modal-content.
245245
*/
246246
contentClassName: PropTypes.string,
247247

248248
/**
249-
* **DEPRECATED** Use `dialog_class_name` instead
249+
* **DEPRECATED** Use `dialog_class_name` instead.
250250
*
251251
* Additional CSS classes to apply to the modal-dialog.
252252
*/
253253
dialogClassName: PropTypes.string,
254254

255255
/**
256-
* **DEPRECATED** Use `autofocus` instead
256+
* **DEPRECATED** Use `autofocus` instead.
257257
*
258258
* Puts the focus on the modal when initialized.
259259
*/
260260
autoFocus: PropTypes.bool,
261261

262262
/**
263-
* **DEPRECATED** Use `labelledby` instead
263+
* **DEPRECATED** Use `labelledby` instead.
264264
*
265265
* The ARIA labelledby attribute
266266
*/
267267
labelledBy: PropTypes.string,
268268

269269
/**
270-
* **DEPRECATED** Use `zindex` instead
270+
* **DEPRECATED** Use `zindex` instead.
271271
*
272272
* Set the z-index of the modal. Default 1050.
273273
*/

src/components/offcanvas/Offcanvas.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,28 +136,28 @@ Offcanvas.propTypes = {
136136
labelledby: PropTypes.string,
137137

138138
/**
139-
* **DEPRECATED** - Use class_name instead.
139+
* **DEPRECATED** Use `class_name` instead.
140140
*
141141
* Additional CSS classes to apply to the Offcanvas
142142
*/
143143
className: PropTypes.string,
144144

145145
/**
146-
* **DEPRECATED** - Use backdrop_class_name instead.
146+
* **DEPRECATED** Use `backdrop_class_name` instead.
147147
*
148148
* CSS class to apply to the backdrop.
149149
*/
150150
backdropClassName: PropTypes.string,
151151

152152
/**
153-
* **DEPRECATED** Use `autofocus` instead
153+
* **DEPRECATED** Use `autofocus` instead.
154154
*
155155
* Puts the focus on the modal when initialized.
156156
*/
157157
autoFocus: PropTypes.bool,
158158

159159
/**
160-
* **DEPRECATED** Use `labelledby` instead
160+
* **DEPRECATED** Use `labelledby` instead.
161161
*
162162
* The ARIA labelledby attribute
163163
*/

src/components/pagination/Pagination.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Pagination.propTypes = {
210210
class_name: PropTypes.string,
211211

212212
/**
213-
* **DEPRECATED** - Use class_name instead.
213+
* **DEPRECATED** Use `class_name` instead.
214214
*
215215
* Additional CSS classes to apply to the Pagination.
216216
*/

src/components/spinner/Spinner.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,14 +259,14 @@ Spinner.propTypes = {
259259
),
260260

261261
/**
262-
* **DEPRECATED** - use `fullscreen_class_name` instead.
262+
* **DEPRECATED** Use `fullscreen_class_name` instead.
263263
*
264264
* Additional CSS classes to apply to the Spinner when fullscreen=True.
265265
*/
266266
fullscreenClassName: PropTypes.string,
267267

268268
/**
269-
* **DEPRECATED** - use `spinner_class_name` instead.
269+
* **DEPRECATED** Use `spinner_class_name` instead.
270270
*
271271
* CSS class names to apply to the spinner.
272272
*/

0 commit comments

Comments
 (0)