sogaiu

background

janet, spork, and > 500 repositories of janet code were analyzed for usage of certain "janet docstring" features.

explanation of listed content

for each feature, what is listed includes:

• a name
• a quantitative indicator (L / U) of intended / unintended occurences

sogaiu

(import remarkable/init :as r)

# XXX: don't strip trailing whitespace from the last line of this
#      long-string, or the test will fail
(def sample
  ``
    Try to move left from `zloc`, skipping over whitespace
    and comment nodes.

    When at least one left move succeeds, return the z-location

sogaiu

(import ./remarkable/init :as r)

(comment

  (def content "hello")

  (r/parse-md content)
  # =>
  [:document @{:container? true 
               :open? true}

sogaiu

Draft - Summary of Recommendations for Janet Docstrings

1. Emphasis

   • Use distinct characters for emphasis and strong emphasis.
   • Don’t use doubled-character delimiters.
   • Simplify emphasis rules. May be don't allow nesting?
   • Introduce special syntax for intraword emphasis, with ~ behaving like a space as far as parsing emphasis goes, but render as nothing.

2. Reference links - Don't have any kind of links

• Don’t make parsing something as a link depend on whether a reference link definition exists elsewhere in the document.

sogaiu

  ``
  (os/compiler)

  Get the compiler used to compile the interpreter. Returns one of:

  * :gcc

  * :clang

sogaiu

Background

In order to get some idea of which "Markdown" features are being used by existing Janet docstrings, generated some data using a simple .janet script (see last file in gist). The output consists of multiple lines of text where (roughly) each line indicates the presence of the first **, *, -, _, or ` in a given docstring.

Explanation of Each Line of Data

sogaiu

How to find "Subscriptions" or "Automatic Payments" - RESOLVED

"Subscriptions" is changed to "Automatic Payments", navigation steps below:

1. (Top right menu) Click the "Gear" icon, to get to Account
2. In Account, click Payments (sub Top menu option)
3. Click button on lower menu Manage Automatic Payments
4. Select radio button Show active

---

sogaiu

Background

• Manage your Apple Account

  What is Apple Account?

  An Apple Account is the personal account you use to access Apple services like the App Store, iCloud, Messages, the Apple Online Store, FaceTime, and more. It includes the information you use to sign in, as well as all the contact, payment, and security details that you’ll use across Apple services.

  What is the difference between an Apple ID and an Apple Account? >

sogaiu

Background

This document describes features that Janet docstrings exhibit (along with a few that are not). As there was no explicit convention established early on nor any supporting automation, the docstrings vary a bit in the way the features have been applied to them.

Below are some descriptions of features along with concrete examples for existing Janet docstrings:

sogaiu

exhibit a - tight

• one item
• another item
• third item

exhibit b - pseudo-loose

• one item