Allow HTML formatting in "description" field in "dataset" and "variable" documentation/metadata entries.

[xuxoramos]

Missing functionality

We are using y-dataprofiler to document several CSVs coming from the Los Angeles Homelessness Services Agency, and some of the fields have very specific rules of usage and of filling out when they appear in surveys. Such rules are in another PDF document, but we wish to have the profiling report as the single source of truth for every dataset/field. To be able to do that, we need the description to accept HTML formatting so we can put rich text in that section both on the variables descriptor and the dataset descriptor.

Proposed feature

Allow the "description" field in the "dataset" and "variables" section of the metadata dictionary to accept HTML formatting.

Alternatives considered

No response

Additional context

No response

[fabclmnt]

hi @xuxoramos ,

ydata-profiling already supports the addition of a description to the report.
Please check the documentation details here: https://docs.profiling.ydata.ai/4.5/features/metadata/. The added "description" details will be depicted in the report - supported for the overall dataset but also for each variable.

Let me know if this is the functionality you were expecting.

[xuxoramos]

It does, partially. The description does not accept HTML formatting. I've managed to do this by removing the "escape" method (see attached img), and now my metadata can contain HTML strings and they will be shown correctly. Data documentation of the Homelessness Information Management System is crucial to the California Policy Lab, where I work, and to the state of CA in general, so I think it's worth it to have a discussion about why the metadata descriptors are being HTML-escaped. Maybe the security you were aiming for is no longer relevant and is taken care of at a lower level? [image: image.png]

…

On Tue, Jul 9, 2024 at 4:47 PM Fabiana ***@***.***> wrote: hi @xuxoramos <https://github.com/xuxoramos> , ydata-profiling already supports the addition of a description to the report. Please check the documentation details here: https://docs.profiling.ydata.ai/4.5/features/metadata/. The added "description" details will be depicted in the report - supported for the overall dataset but also for each variable. Let me know if this is the functionality you were expecting. — Reply to this email directly, view it on GitHub <#1608 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKBM4AIEPGXIKMSXDDWCFLZLRD5JAVCNFSM6AAAAABJOUYTPGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJYG4YDEMJTHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- "Let my armies be the rocks and the trees, and the birds in the sky." --Dr. Henry Jones Sr., PhD