diff options
Diffstat (limited to 'doc/development/reference_processing.md')
-rw-r--r-- | doc/development/reference_processing.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/reference_processing.md b/doc/development/reference_processing.md index 07833c0d302..23c0861081d 100644 --- a/doc/development/reference_processing.md +++ b/doc/development/reference_processing.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: 'An introduction to reference parsers and reference filters, and a guide to their implementation.' --- @@ -101,7 +101,7 @@ format the reference as: This default implementation is not very efficient, because we need to call `#find_object` for each reference, which may require issuing a DB query every -time. For this reason, most reference filter implementations will instead use an +time. For this reason, most reference filter implementations instead use an optimization included in `AbstractReferenceFilter`: > `AbstractReferenceFilter` provides a lazily initialized value @@ -140,7 +140,7 @@ We are skipping: To avoid filtering such nodes for each `ReferenceFilter`, we do it only once and store the result in the result Hash of the pipeline as `result[:reference_filter_nodes]`. -Pipeline `result` is passed to each filter for modification, so every time when `ReferenceFilter` replaces text or link tag, filtered list (`reference_filter_nodes`) will be updated for the next filter to use. +Pipeline `result` is passed to each filter for modification, so every time when `ReferenceFilter` replaces text or link tag, filtered list (`reference_filter_nodes`) are updated for the next filter to use. ## Reference parsers @@ -199,4 +199,4 @@ In practice, all reference parsers inherit from [`BaseParser`](https://gitlab.co - `#nodes_user_can_reference(user, nodes)` to filter nodes directly. A failure to implement this class for each reference type means that the -application will raise exceptions during Markdown processing. +application raises exceptions during Markdown processing. |