moon-jam opened a new pull request, #58760:
URL: https://github.com/apache/airflow/pull/58760

   ## Why
   
   Notice that #58748 fixed a bullet points rendering issue caused by missing 
blank lines before `*`, but some files still have the same problem. This PR 
adds a fix for them.
   
   For example:
   <img width="984" height="171" alt="image" 
src="https://github.com/user-attachments/assets/e734fea4-b018-44bb-8f32-01f0b3ac0450";
 />
   
   ## How
   
   I used a simple script below to check that bullet points render properly and 
fixed them manually.
   
   <details>
   <summary>Script to find bullet points format error</summary>
   
   ```python
   from pathlib import Path
   
   
   def is_bullet_line(line: str) -> bool:
       return line.startswith("* ")
   
   
   def is_blank(line: str) -> bool:
       return line.strip() == ""
   
   
   def main():
       for rst in Path(".").rglob("*.rst"):
           lines = rst.read_text(encoding="utf-8").splitlines()
   
           for i, line in enumerate(lines):
               if not is_bullet_line(line):
                   continue
   
               if i == 0:
                   continue
   
               prev = lines[i - 1]
   
               if is_blank(prev):
                   continue
               if (
                   prev.startswith("*")
                   or prev.startswith(" ")
                   or prev.startswith("=")
                   or prev.startswith("''")
                   or prev.startswith("~")
                   or prev.startswith("-")
               ):
                   continue
   
               print(f"{rst}:{i + 1}: " f'bullet "*" should be preceded by a 
blank line')
   
   
   if __name__ == "__main__":
       main()
   ```
   
   </details>
   
   ## Optional / Future
   
   - Maybe I could integrate a rst linter in pre-commit hook later.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to