Copilot commented on code in PR #3469:
URL: https://github.com/apache/dubbo-go/pull/3469#discussion_r3533872592
##########
server/options.go:
##########
@@ -499,6 +499,9 @@ type ServiceOptions struct {
// for triple non-IDL mode
// consider put here or global.ServiceConfig
// string for url
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // IDLMode switch will not supported by dubbo-go any more.
Review Comment:
Spelling/grammar issues in the deprecation notice ("implemention", "will not
supported") reduce clarity and look unpolished in godoc output.
##########
server/options.go:
##########
@@ -905,6 +908,9 @@ func WithOpenAPIGroup(group string) ServiceOption {
}
// TODO: remove when config package is removed
+//
+// Deprecated: this implemention will be removed in the next version,
+// IDLMode switch will not supported by dubbo-go any more.
Review Comment:
Spelling/grammar issues in the deprecation notice ("implemention", "will not
supported") reduce clarity and look unpolished in godoc output.
##########
protocol/grpc/doc.go:
##########
@@ -16,4 +16,7 @@
*/
// Package grpc implements grpc rpc protocol.
+//
+// Deprecated: this implemention will be removed in the next version,
+// use "dubbo.apache.org/dubbo-go/v3/protocol/triple" instead, which is fully
compatibale with grpc.
Review Comment:
The package deprecation comment contains typos ("implemention",
"compatibale") and inconsistent naming ("grpc" vs "gRPC"), which will surface
in generated docs.
##########
global/reference_config.go:
##########
@@ -48,15 +48,26 @@ type ReferenceConfig struct {
// config
MethodsConfig []*MethodConfig `yaml:"methods" json:"methods,omitempty"
property:"methods"`
// TODO: rename protocol_config to protocol when publish 4.0.0.
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
ProtocolClientConfig *ClientProtocolConfig `yaml:"protocol_config"
json:"protocol_config,omitempty" property:"protocol_config"`
Review Comment:
The deprecation notice has a typo ("implemention") and missing terminal
punctuation, which will appear in generated docs.
##########
protocol/dubbo3/doc.go:
##########
@@ -16,4 +16,7 @@
*/
// Package dubbo3 implements dubbo3.0 rpc protocol.
+//
+// Deprecated: this implemention will be removed in the next version,
+// use "dubbo.apache.org/dubbo-go/v3/protocol/triple" instead.
Review Comment:
The package deprecation comment contains a typo ("implemention"), which will
surface in generated docs.
##########
global/reference_config.go:
##########
@@ -48,15 +48,26 @@ type ReferenceConfig struct {
// config
MethodsConfig []*MethodConfig `yaml:"methods" json:"methods,omitempty"
property:"methods"`
// TODO: rename protocol_config to protocol when publish 4.0.0.
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
ProtocolClientConfig *ClientProtocolConfig `yaml:"protocol_config"
json:"protocol_config,omitempty" property:"protocol_config"`
// TODO: Deprecated：use TripleConfig
// remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval string `yaml:"keep-alive-interval"
json:"keep-alive-interval,omitempty" property:"keep-alive-interval"`
- KeepAliveTimeout string `yaml:"keep-alive-timeout"
json:"keep-alive-timeout,omitempty" property:"keep-alive-timeout"`
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ KeepAliveTimeout string `yaml:"keep-alive-timeout"
json:"keep-alive-timeout,omitempty" property:"keep-alive-timeout"`
Review Comment:
The deprecation notice has a typo ("implemention") and should read as a
complete sentence in docs.
##########
global/reference_config.go:
##########
@@ -48,15 +48,26 @@ type ReferenceConfig struct {
// config
MethodsConfig []*MethodConfig `yaml:"methods" json:"methods,omitempty"
property:"methods"`
// TODO: rename protocol_config to protocol when publish 4.0.0.
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
ProtocolClientConfig *ClientProtocolConfig `yaml:"protocol_config"
json:"protocol_config,omitempty" property:"protocol_config"`
// TODO: Deprecated：use TripleConfig
// remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval string `yaml:"keep-alive-interval"
json:"keep-alive-interval,omitempty" property:"keep-alive-interval"`
Review Comment:
The deprecation notice has a typo ("implemention") and grammar issue ("will
be removed in the next version") that will appear in docs.
##########
global/reference_config.go:
##########
@@ -48,15 +48,26 @@ type ReferenceConfig struct {
// config
MethodsConfig []*MethodConfig `yaml:"methods" json:"methods,omitempty"
property:"methods"`
// TODO: rename protocol_config to protocol when publish 4.0.0.
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
ProtocolClientConfig *ClientProtocolConfig `yaml:"protocol_config"
json:"protocol_config,omitempty" property:"protocol_config"`
// TODO: Deprecated：use TripleConfig
// remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval string `yaml:"keep-alive-interval"
json:"keep-alive-interval,omitempty" property:"keep-alive-interval"`
- KeepAliveTimeout string `yaml:"keep-alive-timeout"
json:"keep-alive-timeout,omitempty" property:"keep-alive-timeout"`
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ KeepAliveTimeout string `yaml:"keep-alive-timeout"
json:"keep-alive-timeout,omitempty" property:"keep-alive-timeout"`
// just for new triple non-IDL mode
// TODO: remove IDLMode when config package is removed
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // IDLMode switch will not supported by dubbo-go any more.
Review Comment:
The deprecation notice has a typo ("implemention") and grammar issue ("will
not supported"), which will appear in docs.
##########
common/constant/key.go:
##########
@@ -28,13 +28,14 @@ const (
)
const (
- GroupKey = "group"
- VersionKey = "version"
- InterfaceKey = "interface"
- MessageSizeKey = "message_size"
- PathKey = "path"
- ServiceKey = "service"
- MethodsKey = "methods"
+ GroupKey = "group"
+ VersionKey = "version"
+ InterfaceKey = "interface"
+ MessageSizeKey = "message_size"
+ PathKey = "path"
+ ServiceKey = "service"
+ MethodsKey = "methods"
+ // Deprecated: this implemention will be removed in the next version,
TimeoutKey = "timeout"
CategoryKey = "category"
CheckKey = "check"
Review Comment:
There is a stray/truncated `Deprecated:` doc comment immediately before
`TimeoutKey`. As written, it marks `TimeoutKey` as deprecated with an
incomplete message, which will leak into godoc and is likely unintended given
how widely `TimeoutKey` is used.
##########
common/constant/key.go:
##########
@@ -60,15 +61,27 @@ const (
ParamsTypeKey = "parameter-type-names" // key used in
pass through invoker factory, to define param type
MetadataTypeKey = "metadata-type"
MaxCallSendMsgSize = "max-call-send-msg-size"
- MaxServerSendMsgSize = "max-server-send-msg-size"
- MaxCallRecvMsgSize = "max-call-recv-msg-size"
- MaxServerRecvMsgSize = "max-server-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerSendMsgSize = "max-server-send-msg-size"
Review Comment:
Typos/grammar in the deprecation notice ("implemention") reduce clarity in
generated docs.
##########
common/constant/key.go:
##########
@@ -60,15 +61,27 @@ const (
ParamsTypeKey = "parameter-type-names" // key used in
pass through invoker factory, to define param type
MetadataTypeKey = "metadata-type"
MaxCallSendMsgSize = "max-call-send-msg-size"
- MaxServerSendMsgSize = "max-server-send-msg-size"
- MaxCallRecvMsgSize = "max-call-recv-msg-size"
- MaxServerRecvMsgSize = "max-server-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerSendMsgSize = "max-server-send-msg-size"
+ MaxCallRecvMsgSize = "max-call-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerRecvMsgSize = "max-server-recv-msg-size"
// TODO: remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval = "keep-alive-interval"
Review Comment:
Typos/grammar in the deprecation notice ("implemention") reduce clarity in
generated docs.
##########
common/constant/key.go:
##########
@@ -60,15 +61,27 @@ const (
ParamsTypeKey = "parameter-type-names" // key used in
pass through invoker factory, to define param type
MetadataTypeKey = "metadata-type"
MaxCallSendMsgSize = "max-call-send-msg-size"
- MaxServerSendMsgSize = "max-server-send-msg-size"
- MaxCallRecvMsgSize = "max-call-recv-msg-size"
- MaxServerRecvMsgSize = "max-server-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerSendMsgSize = "max-server-send-msg-size"
+ MaxCallRecvMsgSize = "max-call-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerRecvMsgSize = "max-server-recv-msg-size"
// TODO: remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval = "keep-alive-interval"
- KeepAliveTimeout = "keep-alive-timeout"
+ // Deprecated: this implemention will be removed in the next version.
+ // use "tripleConfig" instead
+ KeepAliveTimeout = "keep-alive-timeout"
Review Comment:
Typos/grammar in the deprecation notice ("implemention") reduce clarity in
generated docs.
##########
common/constant/key.go:
##########
@@ -60,15 +61,27 @@ const (
ParamsTypeKey = "parameter-type-names" // key used in
pass through invoker factory, to define param type
MetadataTypeKey = "metadata-type"
MaxCallSendMsgSize = "max-call-send-msg-size"
- MaxServerSendMsgSize = "max-server-send-msg-size"
- MaxCallRecvMsgSize = "max-call-recv-msg-size"
- MaxServerRecvMsgSize = "max-server-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerSendMsgSize = "max-server-send-msg-size"
+ MaxCallRecvMsgSize = "max-call-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerRecvMsgSize = "max-server-recv-msg-size"
// TODO: remove KeepAliveInterval and KeepAliveInterval in version 4.0.0
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
KeepAliveInterval = "keep-alive-interval"
- KeepAliveTimeout = "keep-alive-timeout"
+ // Deprecated: this implemention will be removed in the next version.
+ // use "tripleConfig" instead
+ KeepAliveTimeout = "keep-alive-timeout"
// TODO: remove IDLMode after old triple removed
+ //
+ // Deprecated: this implemention will be removed in the next version,
+ // IDLMode switch will not supported by dubbo-go any more.
IDLMode = "IDL-mode"
Review Comment:
The deprecation notice has a typo ("implemention") and grammar issue ("will
not supported"), which will appear in docs.
##########
common/constant/key.go:
##########
@@ -60,15 +61,27 @@ const (
ParamsTypeKey = "parameter-type-names" // key used in
pass through invoker factory, to define param type
MetadataTypeKey = "metadata-type"
MaxCallSendMsgSize = "max-call-send-msg-size"
- MaxServerSendMsgSize = "max-server-send-msg-size"
- MaxCallRecvMsgSize = "max-call-recv-msg-size"
- MaxServerRecvMsgSize = "max-server-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerSendMsgSize = "max-server-send-msg-size"
+ MaxCallRecvMsgSize = "max-call-recv-msg-size"
+ // Deprecated: this implemention will be removed in the next version,
+ // use "tripleConfig" instead
+ MaxServerRecvMsgSize = "max-server-recv-msg-size"
Review Comment:
Typos/grammar in the deprecation notice ("implemention") reduce clarity in
generated docs.
##########
common/constant/key.go:
##########
@@ -79,6 +92,9 @@ const (
// TODO: remove this after old triple removed
// IDLMode
+//
+// Deprecated: this implemention will be removed in the next version,
+// IDLMode switch will not supported by dubbo-go any more.
Review Comment:
The deprecation notice has a typo ("implemention") and grammar issue ("will
not supported"), which will appear in docs.
##########
client/options.go:
##########
@@ -376,6 +376,8 @@ func WithSticky() ReferenceOption {
}
// TODO: remove this function after old triple removed
+//
+// Deprecated: this implemention will be removed in the next version, IDLMode
switch will not supported by dubbo-go any more.
Review Comment:
The deprecation notice has a typo ("implemention") and grammar issue ("will
not supported"), which will appear in docs.
##########
client/action.go:
##########
@@ -149,6 +149,8 @@ func (refOpts *ReferenceOptions) refer(srv
common.RPCService, info *ClientInfo)
// for new triple non-IDL mode
// TODO: remove ISIDL after old triple removed
+ // Deprecated: this implemention will be removed in the next
version,
+ // use "dubbo.apache.org/dubbo-go/v3/protocol/triple" instead,
which is fully compatibale with grpc.
Review Comment:
`// Deprecated:` has special meaning only in doc comments for declarations
(godoc). Here it is inside an argument list, so it doesn't actually deprecate
anything and is easy to misread as a formal deprecation marker.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
