From 92d66a131711bc7817e599c81d081847f689654c Mon Sep 17 00:00:00 2001
From: Mazdak Farrokhzad <twingoow@gmail.com>
Date: Sun, 18 Aug 2019 22:35:53 +0200
Subject: parser: document `parse_pat`.

---
 src/libsyntax/parse/parser/pat.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/libsyntax/parse/parser')

diff --git a/src/libsyntax/parse/parser/pat.rs b/src/libsyntax/parse/parser/pat.rs
index e4a9dc00977..021e52798af 100644
--- a/src/libsyntax/parse/parser/pat.rs
+++ b/src/libsyntax/parse/parser/pat.rs
@@ -16,6 +16,10 @@ type Expected = Option<&'static str>;
 
 impl<'a> Parser<'a> {
     /// Parses a pattern.
+    ///
+    /// Corresponds to `pat<no_top_alt>` in RFC 2535 and does not admit or-patterns
+    /// at the top level. Used when parsing the parameters of lambda expressions,
+    /// functions, function pointers, and `pat` macro fragments.
     pub fn parse_pat(&mut self, expected: Expected) -> PResult<'a, P<Pat>> {
         self.parse_pat_with_range_pat(true, expected)
     }
-- 
cgit 1.4.1-3-g733a5