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

markdown in code table documentation? #8023

Closed
dustymc opened this issue Aug 19, 2024 · 3 comments
Closed

markdown in code table documentation? #8023

dustymc opened this issue Aug 19, 2024 · 3 comments
Labels
Enhancement I think this would make Arctos even awesomer!

Comments

@dustymc
Copy link
Contributor

dustymc commented Aug 19, 2024

Is your feature request related to a problem? Please describe.

I said we'd allow markdown in code table definitions in #8015 (maybe because @mkoo asked me to?). I'm not sure that makes sense in "modernized" code tables, which have dedicated slots for issue and documentation links.

Describe what you're trying to accomplish

Make things as simple as possible yet as complex as necessary

Describe the solution you'd like

Know if there's some compelling reason to support markdown in definitions. At the moment, I don't think there is.

Describe alternatives you've considered

Do nothing.

Additional context

Modernization is underway, see ArctosDB/dev#42

Priority

Only high if an answer here changes something for ArctosDB/dev#42.

@dustymc dustymc added the Enhancement I think this would make Arctos even awesomer! label Aug 19, 2024
@dustymc dustymc added this to the Needs Discussion milestone Aug 19, 2024
@dustymc
Copy link
Contributor Author

dustymc commented Aug 28, 2024

I think this has answered itself. I'm trying to update a code table (https://github.com/ArctosDB/code-table-work/issues/1). I can't save because the current description contains HTML, which is disallowed. The current HTML is not valid - and in an evil sort of way, so I'm pretty happy to find that I can't save it. The thing I'm trying to update is complex and could greatly benefit from some formatting.

I'm going active development, please let me know NOW if that seems like a bad idea for some reason.

@mkoo
Copy link
Member

mkoo commented Aug 28, 2024

I see no objections-- let me know if any content needs to be rewritten in md or simply cleaned up in new version. Please post if testable in test

@dustymc
Copy link
Contributor Author

dustymc commented Aug 28, 2024

content needs to be rewritten

Yes, but probably after ArctosDB/dev#42 (and individual tables can be prioritized - just leave a comment).

testable

https://github.com/ArctosDB/arctos/milestone/14 are testable.

@dustymc dustymc closed this as completed Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement I think this would make Arctos even awesomer!
Projects
None yet
Development

No branches or pull requests

2 participants