docs: improve

[wcxve]

Summary by Sourcery

Documentation:

• Replaced the term 'pivot energy' with 'reference energy' in the documentation of several spectral models for clarity and consistency.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request changes the term 'pivot energy' to 'reference energy' in the documentation of several models within the elisa.models.add module. This change aims to improve the clarity and accuracy of the documentation by using more precise terminology.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Replaced 'pivot energy' with 'reference energy' in the documentation of multiple models.	Replaced 'pivot energy' with 'reference energy' in the Band model documentation. Replaced 'pivot energy' with 'reference energy' in the BandEp model documentation. Replaced 'pivot energy' with 'reference energy' in the CutoffPL model documentation. Replaced 'pivot energy' with 'reference energy' in the Compt model documentation. Replaced 'pivot energy' with 'reference energy' in the OTTB model documentation. Replaced 'pivot energy' with 'reference energy' in the PowerLaw model documentation. Replaced 'pivot energy' with 'reference energy' in the PLPhFlux model documentation. Replaced 'pivot energy' with 'reference energy' in the PLEnFlux model documentation. Replaced 'pivot energy' with 'reference energy' in the SmoothlyBrokenPL model documentation.	src/elisa/models/add.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @wcxve - I've reviewed your changes - here's some feedback:

Overall Comments:

• This looks like a find-and-replace, so double-check that all instances of 'pivot energy' should be changed to 'reference energy'.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}