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

docs: add namespace Go definition to specs #3021

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Jan 17, 2024

I was linking to specs and noticed that the Protobuf section was empty. We don't have a Protobuf definition for namespace but we do have a Go definition.

Ref:

type Namespace struct {
Version uint8
ID []byte
}

I was linking to specs and noticed that the Protobuf section was empty. We don't have a Protobuf definition for namespace but we do have a Go definition.

Ref: https://github.com/celestiaorg/celestia-app/blob/34c98b96fee6e5aaf0ce9cb7b0ec03ee47f24774/pkg/namespace/namespace.go#L8-L11
@rootulp rootulp self-assigned this Jan 17, 2024
@rootulp rootulp enabled auto-merge (squash) January 17, 2024 16:51
Copy link
Contributor

coderabbitai bot commented Jan 17, 2024

Walkthrough

Walkthrough

The update involves integrating a concrete Go struct definition for Namespace into the specifications, which previously contained only a placeholder comment. This addition provides a clear structure with Version and ID fields, aligning the documentation with the actual data representation and types used in the code.

Changes

File Path Change Summary
specs/src/specs/namespace.md Added Go struct definition for Namespace including Version and ID fields.

Related issues

  • celestiaorg/celestia-app#2128: The PR seems to address the proposal to include the protobuf definition of the namespace in the specs, providing a reference for other repositories and clarifying the data types and encoding details.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

PR Preview Action v1.4.6
🚀 Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-3021/
on branch gh-pages at 2024-01-17 16:52 UTC

@celestia-bot celestia-bot requested a review from a team January 17, 2024 16:52
@rootulp rootulp merged commit c8af5bf into main Jan 17, 2024
31 checks passed
@rootulp rootulp deleted the rp/namespace-definition branch January 17, 2024 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants