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

update docs for CID code param to clarify "What kind of code?" #181

Merged
merged 2 commits into from
May 6, 2022

Conversation

gobengo
Copy link
Contributor

@gobengo gobengo commented May 4, 2022

Motivation:

  • 'code' isn't very helpful to a beginner because it has many possible definitions

Concerns:

  • Am I even understanding this right?

Motivation:
* 'code' isn't very helpful to a beginner because it has many possible definitions

Concerns:
* Am I even understanding this right?
Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with this, codec code is common lingo we use for this but your addition is pretty clear

@vmx has stronger opinions about this terminology I think; got any input?

@rvagg rvagg requested a review from vmx May 5, 2022 01:42
@rvagg
Copy link
Member

rvagg commented May 5, 2022

/cc @RangerMauve too for opinions on language and terminology

@rvagg
Copy link
Member

rvagg commented May 5, 2022

oh yea, see CI @gobengo, your jsdoc param name needs to match the actual param name; you could either shift the "multicodec codec" to the comment bit, or perhaps rename the param to be something like codecCode

@gobengo
Copy link
Contributor Author

gobengo commented May 5, 2022

@rvagg fixed the jsdoc and ci

@vmx
Copy link
Member

vmx commented May 5, 2022

@vmx has stronger opinions about this terminology I think; got any input?

I also use "multicodec code" when I talk about this part of the CID. Thanks for pinging me.

@rvagg rvagg merged commit adec0c4 into multiformats:master May 6, 2022
github-actions bot pushed a commit that referenced this pull request May 6, 2022
### [9.6.5](v9.6.4...v9.6.5) (2022-05-06)

### Trivial Changes

* **no-release:** bump actions/checkout from 2.4.0 to 3 ([#172](#172)) ([a1b38c2](a1b38c2))
* **no-release:** bump actions/setup-node from 2.5.1 to 3.0.0 ([#169](#169)) ([8deb4d5](8deb4d5))
* **no-release:** bump actions/setup-node from 3.0.0 to 3.1.0 ([#174](#174)) ([9bcd7fe](9bcd7fe))
* **no-release:** bump mocha from 9.2.2 to 10.0.0 ([#179](#179)) ([b2951dc](b2951dc))
* **no-release:** bump polendina from 2.0.15 to 3.0.0 ([#180](#180)) ([659516b](659516b))
* **no-release:** bump standard from 16.0.4 to 17.0.0 ([#178](#178)) ([2683344](2683344))
* update tsdoc for CID `code` param to clarify "what kind of code?" ([#181](#181)) ([adec0c4](adec0c4))
@github-actions
Copy link

github-actions bot commented May 6, 2022

🎉 This PR is included in version 9.6.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants