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.

Sign up for GitHub

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

Jump to bottom

docs: put mapping in jsdoc #519

Open
cjquines opened this issue Feb 16, 2024 · 1 comment · May be fixed by #581
Open

docs: put mapping in jsdoc #519

cjquines opened this issue Feb 16, 2024 · 1 comment · May be fixed by #581
Labels
docs Related to the documentation and the site feature request New feature or request

Comments

@cjquines
Copy link
Collaborator

cjquines commented Feb 16, 2024 •
edited

it'd be nice to have the mapping on the docs website; right now it's not mentioned

options:

  1. link it on index.astro (aside: this has diverged from the repo README.md; should that be changed?)
  2. parse mapping.md to a file that we can in docs/src/data, then read it for mapping.astro
  3. replace mapping.md with a data file in docs/src/data, then read it for mapping.astro
  4. make new jsdoc tags, say, @lodash and @ramda, then read existing jsdoc output for mapping.astro

(and other options are possible too)

i personally like 4
@eranhirsch
Copy link
Collaborator

We should definitely do 4, and further I think we should drop the mapping concept altogether, and instead improve the search capability so it could look for metadata and not just function names so that searching for the lodash or ramda name would bring up the equivalent function.

I think instead of @lodash and @ramda it would need to be a @mapping tag and we'd configure it to take a param and additional text so that it could be written as:

* @mapping <library> [renamedName] [- additional context/differences/notes]

// Exact copy:
* @mapping lodash 

// Renamed/changes:
* @mapping ramda cond - add `defaultCase()` as last case

// flexible to other libraries we can map to, Hack Standard Library, Python, Go, C, Java, etc...
* @mapping python zip - returns an array, not an iterator

This was referenced Mar 19, 2024
Merged
Open
@eranhirsch eranhirsch added feature request New feature or request docs Related to the documentation and the site labels Mar 29, 2024
@cjquines cjquines changed the title docs: put mapping on docs website docs: put mapping in jsdoc May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Related to the documentation and the site feature request New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: move mapping to jsdoc cjquines/remeda
2 participants
@cjquines @eranhirsch