Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Use solph instead of oemof in the documentation #952

Merged
merged 5 commits into from
Jun 28, 2023

Conversation

lensum
Copy link
Contributor

@lensum lensum commented Jun 26, 2023

Description

The aim of this PR is to consistently refer to solph instead of oemof in the documentation. I seem to remember from the 2022.11 meeting, that oemof should no longer be used synonymously with solph. However, in the documentation sometimes oemof is used while actually referring just to the solph package. A prominent example is the title of the documentation (file docs/index.rst), where it reads "Welcome to oemof's documentation!".

As oemof is a framework containing multiple packages by now, I think it would be better to be precise on which part of oemof is meant.

Questions

  • Which style would be best to use in regular text? I can think of:
    • solph
      • it's the name of the package, after all
    • oemof.solph
      • biggest resemblance to the in-code use
    • oemof-solph
      • also used in the documentation from time to time
      • best solution for bringing the relation between oemof and solph across (imho)

Copy link
Member

@p-snft p-snft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot. What comes on top is that the package is actually called oemof.solph but sometimes the fullstop is not allowed. So, we have to mix oemof.solph and oemof-solph as an alternative.

I already approve as this is already a lot better than before.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
At some locations, it's oemof-solph, because no dot is allowed.
Where it is possible, we should call the project oemof.solph.
@p-snft p-snft merged commit cbe0639 into oemof:dev Jun 28, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants