Skip to content

Commit 6ca1fd5

Browse files
ppekrolppekrol
authored
Merge pull request #2109 from Danielle9897/RDoc-3256-fixReviewComments
RDoc-3445 Fix review comments for RDoc-3256 in the new docs
2 parents 89c8f4d + c6c7961 commit 6ca1fd5

File tree

5 files changed

+140
-85
lines changed

5 files changed

+140
-85
lines changed

‎docs/document-extensions/attachments/indexing.mdx‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
1515
export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"];
1616

1717

18-
# Index Attachments
18+
# Index Attachments
1919
<LanguageSwitcher supportedLanguages={supportedLanguages} />
2020
<LanguageContent language="csharp">
2121

@@ -543,12 +543,13 @@ public class AttachmentName
543543
`}
544544
</CodeBlock>
545545
</TabItem>
546+
546547
#### `LoadAttachment`
547548

548549
<TabItem value="syntax_2" label="syntax_2">
549550
<CodeBlock language="csharp">
550-
{`public IAttachmentObject LoadAttachment(object doc, string name);
551-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
551+
{`// LoadAttachment returns attachment details and methods to access its content.
552+
public IAttachmentObject LoadAttachment(object document, string attachmentName);
552553
`}
553554
</CodeBlock>
554555
</TabItem>
@@ -574,18 +575,20 @@ public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
574575
`}
575576
</CodeBlock>
576577
</TabItem>
578+
577579
#### `LoadAttachments`
578580

579581
<TabItem value="syntax_3" label="syntax_3">
580582
<CodeBlock language="csharp">
581-
{`// Returns a list of all attachments for the specified document.
582-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
583+
{`// Returns a list of ALL attachments for the specified document.
584+
public IEnumerable<IAttachmentObject> LoadAttachments(object document);
583585
`}
584586
</CodeBlock>
585587
</TabItem>
586588

587-
588-
589+
| Parameter | Type | Description |
590+
|----------------|-----------|--------------------------------------------------|
591+
| **document** | `object` | The document whose attachments you want to load. |
589592

590593
</LanguageContent>
591594
<LanguageContent language="java">
@@ -1632,6 +1635,8 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16321635

16331636
## Syntax
16341637

1638+
#### `attachmentsFor`
1639+
16351640
<TabItem value="syntax_1" label="syntax_1">
16361641
<CodeBlock language="js">
16371642
{`attachmentsFor(document);
@@ -1655,17 +1660,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16551660
`}
16561661
</CodeBlock>
16571662
</TabItem>
1663+
1664+
#### `loadAttachment`
1665+
16581666
<TabItem value="syntax_3" label="syntax_3">
16591667
<CodeBlock language="js">
16601668
{`loadAttachment(document, attachmentName);
16611669
`}
16621670
</CodeBlock>
16631671
</TabItem>
16641672

1665-
| Parameter | Type | Description |
1666-
|---------------------|-----------|------------------------------------------------|
1667-
| **document** | `object` | The document whose attachment you want to load |
1668-
| **attachmentName** | `string` | The name of the attachment to load |
1673+
| Parameter | Type | Description |
1674+
|---------------------|-----------|-------------------------------------------------|
1675+
| **document** | `object` | The document whose attachment you want to load. |
1676+
| **attachmentName** | `string` | The name of the attachment to load. |
16691677

16701678
<TabItem value="syntax_4" label="syntax_4">
16711679
<CodeBlock language="js">
@@ -1687,17 +1695,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16871695
`}
16881696
</CodeBlock>
16891697
</TabItem>
1698+
1699+
#### `loadAttachments`
1700+
16901701
<TabItem value="syntax_5" label="syntax_5">
16911702
<CodeBlock language="js">
1692-
{`loadAttachments(document);
1693-
1694-
// Returns a list containing the above attachment object per attachment.
1703+
{`// Returns a list containing the above attachment object per attachment.
1704+
loadAttachments(document);
16951705
`}
16961706
</CodeBlock>
16971707
</TabItem>
16981708

1699-
1700-
1709+
| Parameter | Type | Description |
1710+
|-----------------|-----------|--------------------------------------------------|
1711+
| **document** | `object` | The document whose attachments you want to load. |
17011712

17021713
</LanguageContent>
17031714

@@ -1709,4 +1720,4 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
17091720
- [What are Indexes](../../indexes/what-are-indexes)
17101721

17111722

1712-
-->
1723+
-->

‎versioned_docs/version-5.4/document-extensions/attachments/indexing.mdx‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
1515
export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"];
1616

1717

18-
# Index Attachments
18+
# Index Attachments
1919
<LanguageSwitcher supportedLanguages={supportedLanguages} />
2020
<LanguageContent language="csharp">
2121

@@ -543,12 +543,13 @@ public class AttachmentName
543543
`}
544544
</CodeBlock>
545545
</TabItem>
546+
546547
#### `LoadAttachment`
547548

548549
<TabItem value="syntax_2" label="syntax_2">
549550
<CodeBlock language="csharp">
550-
{`public IAttachmentObject LoadAttachment(object doc, string name);
551-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
551+
{`// LoadAttachment returns attachment details and methods to access its content.
552+
public IAttachmentObject LoadAttachment(object document, string attachmentName);
552553
`}
553554
</CodeBlock>
554555
</TabItem>
@@ -574,18 +575,20 @@ public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
574575
`}
575576
</CodeBlock>
576577
</TabItem>
578+
577579
#### `LoadAttachments`
578580

579581
<TabItem value="syntax_3" label="syntax_3">
580582
<CodeBlock language="csharp">
581-
{`// Returns a list of all attachments for the specified document.
582-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
583+
{`// Returns a list of ALL attachments for the specified document.
584+
public IEnumerable<IAttachmentObject> LoadAttachments(object document);
583585
`}
584586
</CodeBlock>
585587
</TabItem>
586588

587-
588-
589+
| Parameter | Type | Description |
590+
|----------------|-----------|--------------------------------------------------|
591+
| **document** | `object` | The document whose attachments you want to load. |
589592

590593
</LanguageContent>
591594
<LanguageContent language="java">
@@ -1632,6 +1635,8 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16321635

16331636
## Syntax
16341637

1638+
#### `attachmentsFor`
1639+
16351640
<TabItem value="syntax_1" label="syntax_1">
16361641
<CodeBlock language="js">
16371642
{`attachmentsFor(document);
@@ -1655,17 +1660,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16551660
`}
16561661
</CodeBlock>
16571662
</TabItem>
1663+
1664+
#### `loadAttachment`
1665+
16581666
<TabItem value="syntax_3" label="syntax_3">
16591667
<CodeBlock language="js">
16601668
{`loadAttachment(document, attachmentName);
16611669
`}
16621670
</CodeBlock>
16631671
</TabItem>
16641672

1665-
| Parameter | Type | Description |
1666-
|---------------------|-----------|------------------------------------------------|
1667-
| **document** | `object` | The document whose attachment you want to load |
1668-
| **attachmentName** | `string` | The name of the attachment to load |
1673+
| Parameter | Type | Description |
1674+
|---------------------|-----------|-------------------------------------------------|
1675+
| **document** | `object` | The document whose attachment you want to load. |
1676+
| **attachmentName** | `string` | The name of the attachment to load. |
16691677

16701678
<TabItem value="syntax_4" label="syntax_4">
16711679
<CodeBlock language="js">
@@ -1687,17 +1695,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16871695
`}
16881696
</CodeBlock>
16891697
</TabItem>
1698+
1699+
#### `loadAttachments`
1700+
16901701
<TabItem value="syntax_5" label="syntax_5">
16911702
<CodeBlock language="js">
1692-
{`loadAttachments(document);
1693-
1694-
// Returns a list containing the above attachment object per attachment.
1703+
{`// Returns a list containing the above attachment object per attachment.
1704+
loadAttachments(document);
16951705
`}
16961706
</CodeBlock>
16971707
</TabItem>
16981708

1699-
1700-
1709+
| Parameter | Type | Description |
1710+
|-----------------|-----------|--------------------------------------------------|
1711+
| **document** | `object` | The document whose attachments you want to load. |
17011712

17021713
</LanguageContent>
17031714

@@ -1709,4 +1720,4 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
17091720
- [What are Indexes](../../indexes/what-are-indexes)
17101721

17111722

1712-
-->
1723+
-->

‎versioned_docs/version-6.0/document-extensions/attachments/indexing.mdx‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
1515
export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"];
1616

1717

18-
# Index Attachments
18+
# Index Attachments
1919
<LanguageSwitcher supportedLanguages={supportedLanguages} />
2020
<LanguageContent language="csharp">
2121

@@ -543,12 +543,13 @@ public class AttachmentName
543543
`}
544544
</CodeBlock>
545545
</TabItem>
546+
546547
#### `LoadAttachment`
547548

548549
<TabItem value="syntax_2" label="syntax_2">
549550
<CodeBlock language="csharp">
550-
{`public IAttachmentObject LoadAttachment(object doc, string name);
551-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
551+
{`// LoadAttachment returns attachment details and methods to access its content.
552+
public IAttachmentObject LoadAttachment(object document, string attachmentName);
552553
`}
553554
</CodeBlock>
554555
</TabItem>
@@ -574,18 +575,20 @@ public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
574575
`}
575576
</CodeBlock>
576577
</TabItem>
578+
577579
#### `LoadAttachments`
578580

579581
<TabItem value="syntax_3" label="syntax_3">
580582
<CodeBlock language="csharp">
581-
{`// Returns a list of all attachments for the specified document.
582-
public IEnumerable<IAttachmentObject> LoadAttachments(object doc);
583+
{`// Returns a list of ALL attachments for the specified document.
584+
public IEnumerable<IAttachmentObject> LoadAttachments(object document);
583585
`}
584586
</CodeBlock>
585587
</TabItem>
586588

587-
588-
589+
| Parameter | Type | Description |
590+
|----------------|-----------|--------------------------------------------------|
591+
| **document** | `object` | The document whose attachments you want to load. |
589592

590593
</LanguageContent>
591594
<LanguageContent language="java">
@@ -1632,6 +1635,8 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16321635

16331636
## Syntax
16341637

1638+
#### `attachmentsFor`
1639+
16351640
<TabItem value="syntax_1" label="syntax_1">
16361641
<CodeBlock language="js">
16371642
{`attachmentsFor(document);
@@ -1655,17 +1660,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16551660
`}
16561661
</CodeBlock>
16571662
</TabItem>
1663+
1664+
#### `loadAttachment`
1665+
16581666
<TabItem value="syntax_3" label="syntax_3">
16591667
<CodeBlock language="js">
16601668
{`loadAttachment(document, attachmentName);
16611669
`}
16621670
</CodeBlock>
16631671
</TabItem>
16641672

1665-
| Parameter | Type | Description |
1666-
|---------------------|-----------|------------------------------------------------|
1667-
| **document** | `object` | The document whose attachment you want to load |
1668-
| **attachmentName** | `string` | The name of the attachment to load |
1673+
| Parameter | Type | Description |
1674+
|---------------------|-----------|-------------------------------------------------|
1675+
| **document** | `object` | The document whose attachment you want to load. |
1676+
| **attachmentName** | `string` | The name of the attachment to load. |
16691677

16701678
<TabItem value="syntax_4" label="syntax_4">
16711679
<CodeBlock language="js">
@@ -1687,17 +1695,20 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
16871695
`}
16881696
</CodeBlock>
16891697
</TabItem>
1698+
1699+
#### `loadAttachments`
1700+
16901701
<TabItem value="syntax_5" label="syntax_5">
16911702
<CodeBlock language="js">
1692-
{`loadAttachments(document);
1693-
1694-
// Returns a list containing the above attachment object per attachment.
1703+
{`// Returns a list containing the above attachment object per attachment.
1704+
loadAttachments(document);
16951705
`}
16961706
</CodeBlock>
16971707
</TabItem>
16981708

1699-
1700-
1709+
| Parameter | Type | Description |
1710+
|-----------------|-----------|--------------------------------------------------|
1711+
| **document** | `object` | The document whose attachments you want to load. |
17011712

17021713
</LanguageContent>
17031714

@@ -1709,4 +1720,4 @@ where attachmentSize > 20000 or search(attachmentContent, "Colorado Dallas")
17091720
- [What are Indexes](../../indexes/what-are-indexes)
17101721

17111722

1712-
-->
1723+
-->

0 commit comments

Comments
 (0)