Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed #13213 - Use the Helper::parseEscapedMarkedown in notes #13222

Merged
merged 1 commit into from
Jun 29, 2023

Conversation

snipe
Copy link
Owner

@snipe snipe commented Jun 28, 2023

This goes through all of the models that have notes and parses them as markdown. I can't imagine there being any unintended consequences here, but that's why they're called unintended, right? If anyone can think of a way this could mess people up, please chime in here.

Screenshot 2023-06-28 at 3 05 49 PM

Fixes #13213

@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #23427: Make notes parseable as markdown.

@what-the-diff
Copy link

what-the-diff bot commented Jun 28, 2023

PR Summary

  • Enhanced Data Handling
    The parseEscapedMarkedown method from Helper has been added to the notes and note fields in various Transformers. This method allows better processing of data through cleaner data formatting and hence, smoother data transformation.

These Transformers include:

  • AccessoriesTransformer.php
  • ActionlogsTransformer.php
  • AssetMaintenancesTransformer.php
  • AssetModelsTransformer.php
  • AssetsTransformer.php
  • ComponentsTransformer.php
  • ConsumablesTransformer.php
  • LicensesTransformer.php
  • SuppliersTransformer.php
  • UsersTransformer.php

The overall consequence of this change is an improvement in the quality and accuracy of the data that these transformers can handle. This invariably improves the efficiency of the system and the time to process user requests.

@spencerrlongg
Copy link
Collaborator

spencerrlongg commented Jun 28, 2023

The only issue I can think of is how would line breaks be displayed in tables?

Edit: tested
image

Not sure what a good work around would be. Some kind of ... that you can hover to see more in a "tooltip" or something?

@snipe
Copy link
Owner Author

snipe commented Jun 28, 2023

We used to have it with ... if I recall, but it created some confusion since the result (for example search results) may not expose that info, and some people do want to see the entire notes field in those views.

@marcusmoore
Copy link
Collaborator

I didn't actually test this yet but I agree that it should be fine. If this isn't merged before I wrap up a bug fix I'm working on I'll throw some data on it and make sure.

@snipe snipe merged commit 16ce06a into develop Jun 29, 2023
@snipe snipe deleted the feature/sc-23427 branch June 29, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants