Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

Examples Issue: Securities / Equity Options / Handling Data

Open jaredbroad opened this issue 1 year ago • 0 comments

Examples

  • Example 1: Individual: Add contracts expiring this week. Loop through quote bars calc mid price. Use seeder. (10 lines)
  • Example 2: Universe: Filter contracts expiring this week. Loop through quote bars calc mid price. Use seeder. (10 lines)
  • Example 3: Universe: Filter contracts expiring this week. In OnData, get the 1 contracts with delta closest to 0.4.

Remember

  • Don't use variables that aren't defined.
  • Comment every line or few lines.
  • Include 40-100 word explanation.
  • Declare everything you need each example.
  • Copy from IDE to Docs so confirm it works. Copy-pastable examples.
  • ALWAYS make Examples.html at the end.

For the new examples in the docs:

  • There should be a sentence at the beginning of the <h3>Examples</h3>
    • <p>The following examples demonstrate some common practices for _________.</p>
  • Have 1 <h4>Example _: ____________</h4> for each Example.
    • The example should highlight the concepts that were explained on the respective documentation page.
    • Avoid creating tutorial-style content for the text. The text between should at least have a sentence that explains what the algorithm does. "The following algorithm __________:"
    • If there is an opportunity to link some of the text to other pages/sections in the docs, please link it.
    • The example should be a full algorithm in 1 code block, with conventional styling (PEP8 or typical C#; Ask Grok/ChatGPT to help you style/format the code if you need).
    • Test that you can run each example algorithm in QC Cloud w/o error before adding it to the docs.
  • If we have a list of Demonstration Algorithms, put them all under <h4>Other Examples</h4>. The sentence under that heading should read <p>For more examples, see the following algorithms:</p>

jaredbroad avatar Sep 03 '24 22:09 jaredbroad