Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Erin Schnabel <ebullientworks@gmail.com>
  • Loading branch information
gsmet and ebullient committed Mar 21, 2023
1 parent b871337 commit 4c7cb9d
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This guide also covers the testing of the endpoint.

== Solution

We recommend that you follow the instructions from <<bootstrapping-the-project,Bootstrapping project>> and onwards to create the application step by step.
We recommend that you follow the instructions from <<bootstrapping-the-project,Bootstrapping the project>> and onwards to create the application step by step.

However, you can go right to the completed example.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gradle-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Then, attach your debugger to `localhost:5005`.

== Import in your IDE

Once you have a <<project-creation, project generated>>, you can import it in your favorite IDE.
Once you have a <<project-creation,project generated>>, you can import it in your favorite IDE.
The only requirement is the ability to import a Gradle project.

**Eclipse**
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/hibernate-orm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ They will often map to Hibernate ORM configuration properties but could have dif

Also, Quarkus will set many Hibernate ORM configuration settings automatically, and will often use more modern defaults.

For a list of the items that you can set in `{config-file}`, see <<hibernate-configuration-properties, Hibernate ORM configuration properties>>.
For a list of the items that you can set in `{config-file}`, see <<hibernate-configuration-properties,Hibernate ORM configuration properties>>.

An `EntityManagerFactory` will be created based on the Quarkus `datasource` configuration as long as the Hibernate ORM extension is listed among your project dependencies.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/hibernate-reactive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Also, Quarkus will set many Hibernate Reactive configuration settings automatica

WARNING: Configuring Hibernate Reactive using the standard `persistence.xml` configuration file is not supported.

See section <<hr-configuration-properties, Hibernate Reactive configuration properties>> for the list of properties you can set in `{config-file}`.
See section <<hr-configuration-properties,Hibernate Reactive configuration properties>> for the list of properties you can set in `{config-file}`.

A `Mutiny.SessionFactory` will be created based on the Quarkus `datasource` configuration as long as the Hibernate Reactive extension is listed among your project dependencies.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ opening the door to optimization opportunities.
As an example, in native execution the minimum level enables lower level checks (e.g. `isTraceEnabled`) to be folded to `false`,
resulting in dead code elimination for code that will never to be executed.

All possible properties are listed in <<loggingConfigurationReference, the logging configuration reference>> section.
All possible properties are listed in the <<loggingConfigurationReference,logging configuration reference>> section.

NOTE: If you are adding these properties by using the command line, make sure `"` is escaped.
For example `-Dquarkus.log.category.\"org.hibernate\".level=TRACE`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/maven-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Then, attach your debugger to `localhost:5005`.

== Import in your IDE

Once you have a <<project-creation, project generated>>, you can import it in your favorite IDE.
Once you have a <<project-creation,project generated>>, you can import it in your favorite IDE.
The only requirement is the ability to import a Maven project.

**Eclipse**
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/openapi-swaggerui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ The static file to serve must be a valid document conforming to the https://swag
An OpenAPI document that conforms to the OpenAPI Specification is itself a valid JSON object, that can be represented in `yaml` or `json` formats.

To see this in action, we'll put OpenAPI documentation under `META-INF/openapi.yaml` for our `/fruits` endpoints.
Quarkus also supports alternative <<open-document-paths, OpenAPI document paths>> if you prefer.
Quarkus also supports alternative <<open-document-paths,OpenAPI document paths>> if you prefer.

[source,yaml]
----
Expand Down
10 changes: 5 additions & 5 deletions docs/src/main/asciidoc/qute-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ It has one or more parts, where each part represents either a property accessor

When accessing the properties you can either use the dot notation or bracket notation.
In the `object.property` (dot notation) syntax, the `property` must be a <<identifiers,valid identifier>>.
In the `object[property_name]` (bracket notation) syntax, the `property_name` has to be a non-null <<literals, literal>> value.
In the `object[property_name]` (bracket notation) syntax, the `property_name` has to be a non-null <<literals,literal>> value.

An expression can start with an optional namespace followed by a colon (`:`).
A valid namespace consist of alphanumeric characters and underscores.
Expand All @@ -287,7 +287,7 @@ Namespace expressions are resolved differently - see also <<expression_resolutio
<4> namespace `global`, one part: `colors`

A part of an expression can be a _virtual method_ in which case the name can be followed by a list of comma-separated parameters in parentheses.
A parameter of a virtual method can be either a nested expression or a <<literals, literal>> value.
A parameter of a virtual method can be either a nested expression or a <<literals,literal>> value.
We call these methods _"virtual"_ because they do not have to be backed by a real Java method.
You can learn more about virtual methods in the <<virtual_methods,following section>>.

Expand Down Expand Up @@ -332,7 +332,7 @@ You can learn more about virtual methods in the <<virtual_methods,following sect
[[expression_resolution]]
==== Resolution

The first part of the expression is always resolved against the <<current_context_object, current context object>>.
The first part of the expression is always resolved against the <<current_context_object,current context object>>.
If no result is found for the first part it's resolved against the parent context object (if available).
For an expression that starts with a namespace the current context object is found using all the available ``NamespaceResolver``s.
For an expression that does not start with a namespace the current context object is *derived from the position* of the tag.
Expand Down Expand Up @@ -1667,7 +1667,7 @@ The type of a default value must be assignable to the type of the parameter decl
TIP: The default value is actually an <<expressions,expression>>. So the default value does not have to be a literal (such as `42` or `true`). For example, you can leverage the `@TemplateEnum` and specify an enum constant as a default value of a parameter declaration: `{@org.acme.MyEnum myEnum=MyEnum:FOO}`.
However, the infix notation is not supported in default values unless the parentheses are used for grouping, e.g. `{@org.acme.Foo foo=(foo1 ?: foo2)}``.

IMPORTANT: The type of a default value is not validated in <<standalone, Qute standalone>>.
IMPORTANT: The type of a default value is not validated in <<standalone,Qute standalone>>.

.More Parameter Declarations Examples
[source]
Expand Down Expand Up @@ -2306,7 +2306,7 @@ Colors: {#each myColors}{it}{#if it_hasNext}, {/if}{/each} <3>
<2> `age` resolves to `Globals#age`.
<3> `myColors` resolves to `Globals#myColors()`.

NOTE: Note that global variables implicitly add <<typesafe_expressions, parameter declarations>> to all templates and so any expression that references a global variable is validated during build.
NOTE: Note that global variables implicitly add <<typesafe_expressions,parameter declarations>> to all templates and so any expression that references a global variable is validated during build.

.The Output
[source,html]
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/rest-data-panache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ Please, check out the next compatibility table to use the right one according to
|===
|Extension |Hibernate | RESTEasy

|<<hr-hibernate-orm, quarkus-hibernate-orm-rest-data-panache>>
|<<hr-hibernate-orm,quarkus-hibernate-orm-rest-data-panache>>
|`ORM`
|`Classic and Reactive`

|<<hr-hibernate-reactive, quarkus-hibernate-reactive-rest-data-panache>>
|`Reactive`
|`Reactive`

|<<hr-mongodb, quarkus-mongodb-rest-data-panache>>
|<<hr-mongodb,quarkus-mongodb-rest-data-panache>>
|`ORM`
|`Classic and Reactive`
|===
Expand Down Expand Up @@ -162,7 +162,7 @@ implementation("io.quarkus:quarkus-resteasy-reactive-jackson")
----

* Implement the Panache entities and/or repositories as explained in the xref:mongodb-panache.adoc[MongoDB with Panache] guide.
* Define the interfaces for generation as explained in the <<hr-generating-resources, resource generation>> section.
* Define the interfaces for generation as explained in the <<hr-generating-resources,resource generation>> section.

[[hr-generating-resources]]
== Generating resources
Expand Down

0 comments on commit 4c7cb9d

Please sign in to comment.