Merge pull request #1512 from gotd/feat/link-docs

feat: link constructors in docs
gotd · Feb 3, 2025 · 4ba99df · 4ba99df
2 parents 4441ee9 + dcb0119
commit 4ba99df
Show file tree

Hide file tree

Showing 241 changed files with 1,705 additions and 13 deletions.
diff --git a/examples/go.mod b/examples/go.mod
@@ -44,7 +44,7 @@ require (
 	github.com/kr/text v0.2.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/ogen-go/ogen v1.8.1 // indirect
+	github.com/ogen-go/ogen v1.9.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_golang v1.19.0 // indirect
 	github.com/prometheus/client_model v0.5.0 // indirect

diff --git a/examples/go.sum b/examples/go.sum
@@ -75,8 +75,8 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/ogen-go/ogen v1.8.1 h1:7TZ+oIeLkcBiyl0qu0fHPrFUrGWDj3Fi/zKSWg2i2Tg=
-github.com/ogen-go/ogen v1.8.1/go.mod h1:2ShRm6u/nXUHuwdVKv2SeaG8enBKPKAE3kSbHwwFh6o=
+github.com/ogen-go/ogen v1.9.0 h1:n+lDQpiSFYC9G4hTvuNVWnqmIP0LR8ws0faDn9jX3hU=
+github.com/ogen-go/ogen v1.9.0/go.mod h1:vkHpuRyzjdfuRCy81EShi4t9sIgZDcNPGmiDKipRloc=
 github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4=
 github.com/pingcap/errors v0.11.4/go.mod h1:Oi8TUi2kEtXXLMJk9l1cGmz20kV3TaQ0usTwv5KuLY8=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=

diff --git a/gen/_template/interface.tmpl b/gen/_template/interface.tmpl
@@ -10,6 +10,11 @@ const {{ $f.Name }}Name = "{{ $f.RawType }}"
 // See {{ $f.URL }} for reference.
 //
 {{- end }}
+// Constructors:
+{{ range $c := $f.Constructors -}}
+//  - [{{ $c.Name }}]
+{{ end -}}
+//
 // Example:
 //  g, err := {{ $.Config.Package }}.Decode{{ $f.Func }}(buf)
 //  if err != nil {

diff --git a/gen/example/tl_abstract_message_gen.go b/gen/example/tl_abstract_message_gen.go
diff --git a/gen/example/tl_account_themes_gen.go b/gen/example/tl_account_themes_gen.go
diff --git a/gen/example/tl_auth_gen.go b/gen/example/tl_auth_gen.go
diff --git a/gen/example/tl_bool_gen.go b/gen/example/tl_bool_gen.go
diff --git a/gen/example/tl_response_gen.go b/gen/example/tl_response_gen.go
diff --git a/gen/example/tl_text_entity_type_gen.go b/gen/example/tl_text_entity_type_gen.go
diff --git a/gen/example/tl_user_auth_gen.go b/gen/example/tl_user_auth_gen.go
diff --git a/go.mod b/go.mod
@@ -10,7 +10,7 @@ require (
 	github.com/go-faster/xor v1.0.0
 	github.com/go-openapi/inflect v0.21.0
 	github.com/google/uuid v1.6.0
-	github.com/gotd/getdoc v0.47.0
+	github.com/gotd/getdoc v0.48.0
 	github.com/gotd/ige v0.2.2
 	github.com/gotd/neo v0.1.5
 	github.com/gotd/tl v0.4.0
@@ -42,7 +42,7 @@ require (
 	github.com/dlclark/regexp2 v1.11.4 // indirect
 	github.com/fatih/color v1.18.0 // indirect
 	github.com/ghodss/yaml v1.0.0 // indirect
-	github.com/go-faster/sdk v0.18.0 // indirect
+	github.com/go-faster/sdk v0.22.0 // indirect
 	github.com/go-faster/yaml v0.4.6 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect

diff --git a/go.sum b/go.sum
@@ -21,8 +21,8 @@ github.com/go-faster/errors v0.7.1 h1:MkJTnDoEdi9pDabt1dpWf7AA8/BaSYZqibYyhZ20AY
 github.com/go-faster/errors v0.7.1/go.mod h1:5ySTjWFiphBs07IKuiL69nxdfd5+fzh1u7FPGZP2quo=
 github.com/go-faster/jx v1.1.0 h1:ZsW3wD+snOdmTDy9eIVgQdjUpXRRV4rqW8NS3t+20bg=
 github.com/go-faster/jx v1.1.0/go.mod h1:vKDNikrKoyUmpzaJ0OkIkRQClNHFX/nF3dnTJZb3skg=
-github.com/go-faster/sdk v0.18.0 h1:zHwbVfjRO1lkovWxubl75XJdT7hW1mQMrjRtuSgQ0m8=
-github.com/go-faster/sdk v0.18.0/go.mod h1:IWvsQ1GvPtmylD6hzo5myM7kpBEQu43gyC3tcbXC3Q8=
+github.com/go-faster/sdk v0.22.0 h1:s/Pq3lJ00MrHMoEUzeAemPz7kXzfETw2iN6outyOHoY=
+github.com/go-faster/sdk v0.22.0/go.mod h1:UJWFlbuRJHmXJwl4JxStMbbIZtMAz4fxrD4CnuDXCIc=
 github.com/go-faster/xor v0.3.0/go.mod h1:x5CaDY9UKErKzqfRfFZdfu+OSTfoZny3w5Ak7UxcipQ=
 github.com/go-faster/xor v1.0.0 h1:2o8vTOgErSGHP3/7XwA5ib1FTtUsNtwCoLLBjl31X38=
 github.com/go-faster/xor v1.0.0/go.mod h1:x5CaDY9UKErKzqfRfFZdfu+OSTfoZny3w5Ak7UxcipQ=
@@ -39,8 +39,8 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gotd/getdoc v0.47.0 h1:lQmDcxP+3t+hYci/krHURecvtF1uvk/UmoV4r7zc6Dc=
-github.com/gotd/getdoc v0.47.0/go.mod h1:lTJpE9q9HXkmVRI6VqE2EBY4LZ5dQflRocnweG8ffMU=
+github.com/gotd/getdoc v0.48.0 h1:oo0C/tNHOwZsuW5egYhrD4XLtlAnz2ubSfz6tdh0FEM=
+github.com/gotd/getdoc v0.48.0/go.mod h1:w5IDi4f2qAfBjk7CmzVKpTRU1/jGSZinwZ2Gxej1XvA=
 github.com/gotd/ige v0.2.2 h1:XQ9dJZwBfDnOGSTxKXBGP4gMud3Qku2ekScRjDWWfEk=
 github.com/gotd/ige v0.2.2/go.mod h1:tuCRb+Y5Y3eNTo3ypIfNpQ4MFjrnONiL2jN2AKZXmb0=
 github.com/gotd/neo v0.1.5 h1:oj0iQfMbGClP8xI59x7fE/uHoTJD7NZH9oV1WNuPukQ=

diff --git a/mt/tl_bad_msg_notification_gen.go b/mt/tl_bad_msg_notification_gen.go
diff --git a/mt/tl_destroy_session_res_gen.go b/mt/tl_destroy_session_res_gen.go
diff --git a/mt/tl_msg_detailed_info_gen.go b/mt/tl_msg_detailed_info_gen.go
diff --git a/mt/tl_p_q_inner_data_gen.go b/mt/tl_p_q_inner_data_gen.go
diff --git a/mt/tl_rpc_drop_answer_gen.go b/mt/tl_rpc_drop_answer_gen.go
diff --git a/mt/tl_server_d_h_params_gen.go b/mt/tl_server_d_h_params_gen.go
diff --git a/mt/tl_set_client_d_h_params_answer_gen.go b/mt/tl_set_client_d_h_params_answer_gen.go
diff --git a/tg/e2e/tl_bool_gen.go b/tg/e2e/tl_bool_gen.go
diff --git a/tg/e2e/tl_decrypted_message_action_gen.go b/tg/e2e/tl_decrypted_message_action_gen.go
diff --git a/tg/e2e/tl_decrypted_message_gen.go b/tg/e2e/tl_decrypted_message_gen.go
diff --git a/tg/e2e/tl_decrypted_message_media_gen.go b/tg/e2e/tl_decrypted_message_media_gen.go
diff --git a/tg/e2e/tl_document_attribute_gen.go b/tg/e2e/tl_document_attribute_gen.go
diff --git a/tg/e2e/tl_file_location_gen.go b/tg/e2e/tl_file_location_gen.go
diff --git a/tg/e2e/tl_input_sticker_set_gen.go b/tg/e2e/tl_input_sticker_set_gen.go
diff --git a/tg/e2e/tl_message_entity_gen.go b/tg/e2e/tl_message_entity_gen.go