[flang-commits] [PATCH] D130166: [flang] Adding a guideline for flang design documentation

[Diana Picus via Phabricator via flang-commits]

rovka added inline comments.


================
Comment at: flang/docs/DesignGuideline.md:21
+
+The preferred organization of such documents is:
+1) Problem description
----------------
Do we have any examples in tree already?


================
Comment at: flang/docs/DesignGuideline.md:70
+- Identify the relevant sections and constraints in the standard.
+- Write Fortran program using the feature and, if possible,
+  verify your expectations with existing compilers.
----------------



================
Comment at: flang/docs/DesignGuideline.md:73
+- Check if the related constraints (Cxxx numbers in the standard) are enforced
+  by semantics. If not it is good idea to start by adding the related checks
+  (this does not require writing a design document).
----------------



================
Comment at: flang/docs/DesignGuideline.md:82
+- Identify related features, or contexts that matter for the feature (e.g,
+  does being in an internal procedure, a module, a block… changes anything
+  to what should happen?).
----------------



Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D130166/new/

https://reviews.llvm.org/D130166