Docs: Update SayHello Function Example in Ignite Documentation to to Align with Latest Ignite

[hiroyukikumazawa]

Description

The example provided in the Ignite documentation for customizing the query response (located here) uses an older version of the SayHello function in the x/hello/keeper/query_say_hello.go file. A recent review of the source code shows modifications that should be reflected in the documentation to ensure it stays current and useful for developers.

Old Version

package keeper

import (
    "context"
    "fmt"

    sdk "github.com/cosmos/cosmos-sdk/types"
    "google.golang.org/grpc/codes"
    "google.golang.org/grpc/status"

    "hello/x/hello/types"
)

func (k Keeper) SayHello(goCtx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
    if req == nil {
        return nil, status.Error(codes.InvalidArgument, "invalid request")
    }

    // Validation and Context unwrapping
    ctx := sdk.UnwrapSDKContext(goCtx)

    _ = ctx
    // Custom Response
    return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
}

New Version

package keeper

import (
	"context"
	"fmt"

	"hello/x/hello/types"

	sdk "github.com/cosmos/cosmos-sdk/types"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

func (q queryServer) SayHello(ctx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
	if req == nil {
		return nil, status.Error(codes.InvalidArgument, "invalid request")
	}

	// Validation and Context unwrapping
	sdkCtx := sdk.UnwrapSDKContext(ctx)

	_ = sdkCtx
	// Custom Response
	return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
}

Suggested Update for Documentation

It would be beneficial for the documentation to be updated to reflect the changes in the source code. This ensures that new developers using the Ignite framework can have accurate examples that match the codebase they are working with.

Additionally, adding a brief explanation about the reason behind these changes (if applicable) might help developers understand the evolution of the code structure in Ignite.

[hiroyukikumazawa]

Here is the default file of the latest version.

package keeper

import (
	"context"

	"hello/x/hello/types"

	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

func (q queryServer) SayHello(ctx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
	if req == nil {
		return nil, status.Error(codes.InvalidArgument, "invalid request")
	}

	// TODO: Process the query

	return &types.QuerySayHelloResponse{}, nil
}