Skip to content

Commit bca0472

Browse files
committed
docs: reformat fields=... params
1 parent b7ad5d9 commit bca0472

File tree

3 files changed

+29
-88
lines changed

3 files changed

+29
-88
lines changed

docs/tutorials/multi-collections.ipynb

Lines changed: 16 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -402,114 +402,50 @@
402402
" fields=infer_fields(split_factory.data[\"stays\"], visible_keys=[\"stay_id\", \"service\"]),\n",
403403
")\n",
404404
"\n",
405+
"# fmt: off\n",
405406
"split_notes_view = split_factory.create_table_widget(\n",
406407
" store_key=\"notes\",\n",
407408
" primary_key=\"note_id\",\n",
408409
" # or we could use infer_fields\n",
409410
" fields=[\n",
410-
" {\n",
411-
" \"key\": \"note_id\",\n",
412-
" \"name\": \"note_id\",\n",
413-
" \"kind\": \"hyperlink\",\n",
414-
" \"editable\": False,\n",
415-
" \"filterable\": True,\n",
416-
" \"options\": None,\n",
417-
" },\n",
418-
" {\n",
419-
" \"key\": \"stay_id\",\n",
420-
" \"name\": \"stay_id\",\n",
421-
" \"kind\": \"text\",\n",
422-
" \"editable\": False,\n",
423-
" \"filterable\": True,\n",
424-
" \"options\": None,\n",
425-
" },\n",
426-
" {\n",
427-
" \"key\": \"note_text\",\n",
428-
" \"name\": \"note_text\",\n",
429-
" \"kind\": \"text\",\n",
430-
" \"editable\": False,\n",
431-
" \"filterable\": True,\n",
432-
" \"options\": None,\n",
433-
" },\n",
411+
" {\"key\": \"note_id\", \"name\": \"note_id\", \"kind\": \"hyperlink\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
412+
" {\"key\": \"stay_id\", \"name\": \"stay_id\", \"kind\": \"text\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
413+
" {\"key\": \"note_text\", \"name\": \"note_text\", \"kind\": \"text\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
434414
" ],\n",
435415
")\n",
416+
"# fmt: on\n",
436417
"\n",
418+
"# fmt: off\n",
437419
"split_entities_view = split_factory.create_table_widget(\n",
438420
" store_key=\"entities\",\n",
439421
" primary_key=\"id\",\n",
440422
" # or we could use infer_fields\n",
441423
" fields=[\n",
442-
" {\n",
443-
" \"key\": \"id\",\n",
444-
" \"name\": \"id\",\n",
445-
" \"kind\": \"hyperlink\",\n",
446-
" \"editable\": False,\n",
447-
" \"filterable\": True,\n",
448-
" \"options\": None,\n",
449-
" },\n",
450-
" {\n",
451-
" \"key\": \"stay_id\",\n",
452-
" \"name\": \"stay_id\",\n",
453-
" \"kind\": \"text\",\n",
454-
" \"editable\": False,\n",
455-
" \"filterable\": True,\n",
456-
" \"options\": None,\n",
457-
" },\n",
458-
" {\n",
459-
" \"key\": \"note_id\",\n",
460-
" \"name\": \"note_id\",\n",
461-
" \"kind\": \"text\",\n",
462-
" \"editable\": False,\n",
463-
" \"filterable\": True,\n",
464-
" \"options\": None,\n",
465-
" },\n",
466-
" {\n",
467-
" \"key\": \"label\",\n",
468-
" \"name\": \"label\",\n",
469-
" \"kind\": \"text\",\n",
470-
" \"editable\": True,\n",
471-
" \"filterable\": True,\n",
472-
" \"options\": [\"date\", \"procedure\"],\n",
473-
" },\n",
474-
" {\n",
475-
" \"key\": \"mammography\",\n",
476-
" \"name\": \"mammo\",\n",
477-
" \"kind\": \"boolean\",\n",
478-
" \"editable\": True,\n",
479-
" \"filterable\": True,\n",
480-
" \"options\": None,\n",
481-
" },\n",
424+
" {\"key\": \"id\", \"name\": \"id\", \"kind\": \"hyperlink\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
425+
" {\"key\": \"stay_id\", \"name\": \"stay_id\", \"kind\": \"text\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
426+
" {\"key\": \"note_id\", \"name\": \"note_id\", \"kind\": \"text\", \"editable\": False, \"filterable\": True, \"options\": None},\n",
427+
" {\"key\": \"label\", \"name\": \"label\", \"kind\": \"text\", \"editable\": True, \"filterable\": True, \"options\": [\"date\", \"procedure\"]},\n",
428+
" {\"key\": \"mammography\", \"name\": \"mammo\", \"kind\": \"boolean\", \"editable\": True, \"filterable\": True, \"options\": None},\n",
482429
" ],\n",
483430
")\n",
431+
"# fmt: on\n",
484432
"\n",
433+
"# fmt: off\n",
485434
"split_note_text_view, split_ent_toolbar = split_factory.create_text_widget(\n",
486435
" store_text_key=\"notes\",\n",
487436
" store_spans_key=\"entities\",\n",
488437
" text_key=\"note_text\",\n",
489438
" text_primary_key=\"note_id\",\n",
490439
" spans_primary_key=\"id\",\n",
491440
" fields=[\n",
492-
" {\n",
493-
" \"key\": \"label\",\n",
494-
" \"name\": \"label\",\n",
495-
" \"kind\": \"text\",\n",
496-
" \"editable\": True,\n",
497-
" \"filterable\": True,\n",
498-
" \"options\": [\"date\", \"procedure\"],\n",
499-
" },\n",
500-
" {\n",
501-
" \"key\": \"mammography\",\n",
502-
" \"name\": \"mammo\",\n",
503-
" \"kind\": \"boolean\",\n",
504-
" \"editable\": True,\n",
505-
" \"filterable\": True,\n",
506-
" \"options\": None,\n",
507-
" },\n",
441+
" {\"key\": \"label\", \"name\": \"label\", \"kind\": \"text\", \"editable\": True, \"filterable\": True, \"options\": [\"date\", \"procedure\"]},\n",
442+
" {\"key\": \"mammography\", \"name\": \"mammo\", \"kind\": \"boolean\", \"editable\": True, \"filterable\": True, \"options\": None},\n",
508443
" ],\n",
509444
" labels={\n",
510445
" \"date\": {\"name\": \"Date\", \"color\": \"lightblue\"},\n",
511446
" },\n",
512447
")\n",
448+
"# fmt: on\n",
513449
"\n",
514450
"split_layout = div(\n",
515451
" Layout(\n",

docs/tutorials/run-quaero-explorer.ipynb

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -280,26 +280,22 @@
280280
"outputs": [],
281281
"source": [
282282
"note_form_handle: RefType[FormWidgetHandle] = use_ref()\n",
283+
"# fmt: off\n",
283284
"note_form_view = factory.create_form_widget(\n",
284285
" store_key=\"notes\",\n",
285286
" primary_key=\"note_id\",\n",
286287
" # Instead of using infer_fields, we can also define the\n",
287288
" # fields manually which can actually be simpler\n",
288289
" fields=[\n",
289290
" {\"key\": \"note_id\", \"kind\": \"text\"},\n",
290-
" {\n",
291-
" \"key\": \"note_kind\",\n",
292-
" \"kind\": \"radio\",\n",
293-
" \"editable\": True,\n",
294-
" \"options\": [\"interesting\", \"very interesting\"],\n",
295-
" \"filterable\": True,\n",
296-
" },\n",
291+
" {\"key\": \"note_kind\", \"kind\": \"radio\", \"editable\": True, \"options\": [\"interesting\", \"very interesting\"], \"filterable\": True},\n",
297292
" {\"key\": \"seen\", \"kind\": \"boolean\", \"editable\": True},\n",
298293
" ],\n",
299294
" add_navigation_buttons=True,\n",
300295
" style={\"--min-notebook-height\": \"300px\", \"margin\": \"10px\"},\n",
301296
" handle=note_form_handle,\n",
302-
")"
297+
")\n",
298+
"# fmt: on"
303299
]
304300
},
305301
{

pyproject.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ pret = "pret.cli:app"
6868
# ----- Linting & Testing -----
6969
[tool.ruff]
7070
fix = true
71+
force-exclude = true
7172
exclude = [
7273
".git",
7374
"__pycache__",
@@ -87,9 +88,17 @@ lint.select = [
8788
]
8889
lint.fixable = ["E", "F", "W", "I"]
8990

91+
[tool.ruff.format]
92+
exclude = [
93+
"docs/tutorials/multi-collections.ipynb",
94+
"docs/tutorials/run-quaero-explorer.ipynb",
95+
]
96+
9097
[tool.ruff.lint.extend-per-file-ignores]
9198
# Also ignore `E402` in all `__init__.py` files.
9299
"__init__.py" = ["E402", "F401"]
100+
"docs/tutorials/multi-collections.ipynb" = ["E501"]
101+
"docs/tutorials/run-quaero-explorer.ipynb" = ["E501"]
93102

94103
[tool.ruff.lint.isort]
95104
known-third-party = ["pret"]

0 commit comments

Comments
 (0)