docs(img): unencoded img tag in readme (ionic-team#19172)

abennouna · Aug 27, 2019 · 7f66647 · 7f66647
1 parent 48a2763
commit 7f66647
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/core/src/components.d.ts b/core/src/components.d.ts
@@ -880,7 +880,7 @@ export namespace Components {
     */
     'alt'?: string;
     /**
-    * The image URL. This attribute is mandatory for the <img> element.
+    * The image URL. This attribute is mandatory for the `<img>` element.
     */
     'src'?: string;
   }
@@ -4373,7 +4373,7 @@ declare namespace LocalJSX {
     */
     'onIonImgWillLoad'?: (event: CustomEvent<void>) => void;
     /**
-    * The image URL. This attribute is mandatory for the <img> element.
+    * The image URL. This attribute is mandatory for the `<img>` element.
     */
     'src'?: string;
   }

diff --git a/core/src/components/img/img.tsx b/core/src/components/img/img.tsx
@@ -25,7 +25,7 @@ export class Img implements ComponentInterface {
   @Prop() alt?: string;
 
   /**
-   * The image URL. This attribute is mandatory for the <img> element.
+   * The image URL. This attribute is mandatory for the `<img>` element.
    */
   @Prop() src?: string;
   @Watch('src')

diff --git a/core/src/components/img/readme.md b/core/src/components/img/readme.md
@@ -73,7 +73,7 @@ export const ImgExample: React.FC = () => (
 | Property | Attribute | Description                                                                                                                                                                                                              | Type                  | Default     |
 | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- | ----------- |
 | `alt`    | `alt`     | This attribute defines the alternative text describing the image. Users will see this text displayed if the image URL is wrong, the image is not in one of the supported formats, or if the image is not yet downloaded. | `string \| undefined` | `undefined` |
-| `src`    | `src`     | The image URL. This attribute is mandatory for the <img> element.                                                                                                                                                        | `string \| undefined` | `undefined` |
+| `src`    | `src`     | The image URL. This attribute is mandatory for the `<img>` element.                                                                                                                                                      | `string \| undefined` | `undefined` |
 
 
 ## Events