From 77937bd0eef70376bf27d030d4680d175fdc39e0 Mon Sep 17 00:00:00 2001 From: Kristen Brown Date: Wed, 18 Dec 2024 13:24:48 -0500 Subject: [PATCH] Update index.md adjusting GenAI code example indent for visual clarity --- styleguide/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/styleguide/index.md b/styleguide/index.md index 59bdf22..e861d7a 100644 --- a/styleguide/index.md +++ b/styleguide/index.md @@ -438,7 +438,8 @@ title: O'Reilly Style Guide

We want to accurately replicate the back-and-forth between human and AI. Human prompts can be edited very lightly (e.g., punctuation, capitalization), but AI-generated text should be kept verbatim. If AI output is edited for some reason, be sure to still acknowledge the AI's contribution. It must be clear what is AI-generated.

Display content that has a programming context in a code block, with a normal paragraph separating the prompt and the response as needed. The code content should be left verbatim, for the most part, though typos can be flagged for author/production attention. There will not be syntax highlighting. Here is an example:

-
prompt = "Write an email apologizing to Sarah for the tragic gardening mishap. Explain how it happened."
+ 
prompt = "Write an email apologizing to Sarah for the tragic gardening mishap. 
+          Explain how it happened."
 
 output = generator(prompt)
 
@@ -450,7 +451,7 @@ Subject: My Sincere Apologies for the Gardening Mishap
 
 Dear Sarah,
 
-I hope this message finds you well. I am writing to express my deep
+I hope this message finds you well. I am writing to express my deep...

back to top