Skip to content

Param with multiple types not pulled correctlyΒ #5

@iamdharmesh

Description

@iamdharmesh

Describe the bug

While reviewing the ClassifAI dev docs, @dkotter noticed (https://10up.github.io/classifai/hooks/Actions/classifai\_openai\_embeddings\_single\_embedding\_similarity/) that parameters with multiple types are not being pulled correctly.

This issue occurs because the | separator is not being escaped properly during the JSON β†’ Markdown conversion, and is ultimately treated as a table separator in Markdown.

Steps to Reproduce

  1. Add a parameter with multiple types in your plugin hook.
  2. Generate the docs.
  3. Notice that the parameter table does not contain the correct information for both the type and the parameter description.

Screenshots, screen recording, code snippet

No response

Environment information

No response

WordPress information

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions