Skip to content

pgsphere or pg_sphere? #67

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
vitcpp opened this issue Sep 22, 2023 · 4 comments
Open

pgsphere or pg_sphere? #67

vitcpp opened this issue Sep 22, 2023 · 4 comments

Comments

@vitcpp
Copy link
Contributor

vitcpp commented Sep 22, 2023

The repository name is pgsphere. The extension name is pg_sphere. The document uses pgSphere. The names are not consistent. I propose to think about this problem.

@df7cb
Copy link
Contributor

df7cb commented Sep 22, 2023

Not the same question, but there's also a giant dichotomy between the naming of SQL functions and C functions, e.g. scircle_* vs spherecircle_*. And half of the C/SQL files are named pgs_* while the rest doesn't have a prefix. It's very confusing.

@esabol
Copy link
Contributor

esabol commented Sep 22, 2023

The repository name is pgsphere. The extension name is pg_sphere. The document uses pgSphere. The names are not consistent. I propose to think about this problem.

I much prefer pgsphere, and I think it's acceptable to use pgSphere in the documentation.

I really don't like pg_sphere for the extension name, but I think changing it at this point would be problematic for people who already have the extension installed. I think we are stuck with it, but I don't want to change anything else to match it.

So, basically, I wouldn't change anything.

@vitcpp
Copy link
Contributor Author

vitcpp commented Sep 22, 2023

I would prefer pgsphere as well. I agree we shouldn't rename the extension.

Some more questions:

  • Should we use pgsphere when naming source files or doc files (like, pgsphere-1.3.1-A4.pdf)?
  • Should we use pgSphere or PgSphere in doc titles?

For certainty, I would propose to use pgsphere for the following cases:

  • Repository name
  • File and directory naming (?)
  • Documentation

Use pg_sphere:

  • Module name
  • Function names (like, pg_sphere_version)

Then, we may describe such naming chaos it in the doc.

@df7cb
Copy link
Contributor

df7cb commented Nov 8, 2023

I'd put a +1 on pgSphere, the spelling with PgS looks weird to me.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants