Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Documentation does not match type definition #4070

Closed
arseniy-gl opened this issue Mar 21, 2022 · 5 comments
Closed

Documentation does not match type definition #4070

arseniy-gl opened this issue Mar 21, 2022 · 5 comments
Assignees
Labels
good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) topic/docs Documentation

Comments

@arseniy-gl
Copy link

  • Version: ipfs-core: 0.14.1
  • Subsystem: types, core

Severity: Very Low

Description:

in type definition put: (...) => Promise<CID>, but docs Promise<Block>

Which type is correct?

@arseniy-gl arseniy-gl added the need/triage Needs initial labeling and prioritization label Mar 21, 2022
@welcome
Copy link

welcome bot commented Mar 21, 2022

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

@lidel lidel added kind/bug A bug in existing code (including security flaws) help wanted Seeking public contribution on this issue topic/docs Documentation good first issue Good issue for new contributors and removed need/triage Needs initial labeling and prioritization labels Apr 1, 2022
@lidel
Copy link
Member

lidel commented Apr 1, 2022

@arseniy-gl the type is correct – mind opening a PR that fixes the docs?

@progmatic-99
Copy link

@lidel This can be closed, i guess??

@yves-ganza
Copy link

@lidel This issue looks like it's been handled and now the Documentation match type definition.

I was looking for "good first issue" tags and this is what came up. Let me know if you have any suggestions :)

@achingbrain
Copy link
Member

Closing as this has been resolved.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) topic/docs Documentation
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants