Skip to content

Commit

Permalink
Correct issues with rendering (#2531)
Browse files Browse the repository at this point in the history
  • Loading branch information
hpmellema authored Feb 19, 2025
1 parent 4307434 commit 2f5e97d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/source-2.0/java/client/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Default plugins
^^^^^^^^^^^^^^^

Plugins can be applied by default at client instantiation. To apply a plugin by default, add the plugin’s
fully qualified name to the ``defaultPlugins``` setting to your :ref`smithy-build <smithy-build>` configuration:
fully qualified name to the ``defaultPlugins`` setting to your :ref`smithy-build <smithy-build>` configuration:

.. code-block:: json
:caption: smithy-build.json
Expand Down
32 changes: 16 additions & 16 deletions docs/source-2.0/java/client/generating-clients.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Initial setup: Gradle (recommended)

To generate a Java client for a service, start by creating a new Smithy Gradle project.

The ``smithy init``` CLI command can be used to create a new Smithy Gradle project:
The ``smithy init`` CLI command can be used to create a new Smithy Gradle project:

.. code-block:: sh
Expand All @@ -43,10 +43,10 @@ and execute build plugins:
.. code-block:: diff
:caption: build.gradle.kts
plugins {
`java-library`
+ id("software.amazon.smithy.gradle.smithy-base") version "__smithy_gradle_version__"
}
plugins {
`java-library`
+ id("software.amazon.smithy.gradle.smithy-base") version "__smithy_gradle_version__"
}
Add the following dependencies to your project:

Expand Down Expand Up @@ -84,16 +84,16 @@ your :ref:`smithy-build <smithy-build>` config:
.. code-block:: diff
:caption: smithy-build.json
{
"version": "1.0",
"plugins": {
+ "java-client-codegen": {
+ "service": "com.example#CoffeeShop", // <- Replace with your service's ID
+ // Generated Java code will use this as the root package namespace
+ "namespace": "com.example.cafe"
+ }
}
}
{
"version": "1.0",
"plugins": {
+ "java-client-codegen": {
+ "service": "com.example#CoffeeShop", // <- Replace with your service's ID
+ // Generated Java code will use this as the root package namespace
+ "namespace": "com.example.cafe"
+ }
}
}
----------------------------------------
Add generated code to the Java sourceSet
Expand Down Expand Up @@ -162,7 +162,7 @@ Gradle project to generate a Smithy Java client:
implementation("...")
// Add the client-core dependency needed by the generated code
implementation("software.amazon.smithy.java:client-core:__smithy_java_version__"")
implementation("software.amazon.smithy.java:client-core:__smithy_java_version__")
// Also add your protocol implementations or auth schemes as dependencies
implementation("com.example:my-protocol:1.0.0")
Expand Down
2 changes: 1 addition & 1 deletion docs/source-2.0/java/client/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Use the plugin to return canned responses from the http client:
UserAgentPlugin
---------------

The ``UserAgentPlugin``adds a default ``User-Agent`` header to an HTTP request if none is set.
The ``UserAgentPlugin`` adds a default ``User-Agent`` header to an HTTP request if none is set.

.. note::

Expand Down

0 comments on commit 2f5e97d

Please sign in to comment.