search

200ok-ch / org-parser

org-parser is a parser for the Org mode markup language for Emacs.
GNU Affero General Public License v3.0
316 stars 15 forks source link

[WIP] Rename parse function? #54

Closed schoettl closed 3 years ago

schoettl commented 3 years ago

Is there a reason why we called the function to parse org file content just parser/org? For me it was first not clear what the function does because of it's name. So I'd suggest parse-org instead. But maybe it's a convention from data.csv, data.json, etc.?

Should we rename it?

Closes #19

This would make the tests a bit more verbose.

schoettl commented 3 years ago

Sample code from README

(ns hello-world.core
  (:require [org-parser.parser :refer [org]]))

(org "* Headline")

@munen @branch14 what do you think? org or better parse-org?

munen commented 3 years ago

@munen @branch14 what do you think? org or better parse-org?

Tbh, I'm tending to the third option parse(;

Rationale: The package/namespace already says what it's all about: What does org-parserdo? It parses.

By convention, functions are often verbs. In FP, it's all about doing. So org isn't a good option, imo. I can totally live with org-parser/parse-org, if you're preferring that, though!

schoettl commented 3 years ago

I'm good with parse, too!

munen commented 3 years ago

:+1: