Skip to content

Conversation

ADIMANV
Copy link
Contributor

@ADIMANV ADIMANV commented Jan 30, 2025

Pull Request

Description

The PR updates missing docs on india-api, making it more user friendly.
It is in accordance to the issue: #66 (comment)
image

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

@ADIMANV ADIMANV requested a review from peterdudfield January 30, 2025 13:38
@peterdudfield
Copy link
Contributor

Can you run it locally? and provide a screen shot?

@peterdudfield
Copy link
Contributor

You need to update the document to match what the input object is.
The input object here use"PowerKW" and "Time"

All timestamps (Time) are in UTC.
**Note**: Users should wait up to 7 days to start experiencing the full
Copy link
Contributor

Choose a reason for hiding this comment

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

Change this to 1 day

README.md Outdated
### Configuration

The application is configured via the use of environment variables.
For the environment variable please set: `export DB_URL=postgresql://main:vPV%xXs6AiviZ8WP@127.0.0.1:5433/indiadbdevelopment` in bash
Copy link
Contributor

Choose a reason for hiding this comment

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

remove the actuall DB_URL

README.md Outdated
### Configuration

The application is configured via the use of environment variables.
For the environment variable please set: `export DB_URL=postgresql://localhost:5432` in bash
Copy link
Contributor

Choose a reason for hiding this comment

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

For the environment variable please set: DB_URL in bash

@peterdudfield
Copy link
Contributor

Looks great @ADIMANV , Ill let you merge when you are happy

@ADIMANV ADIMANV merged commit 43297bd into main Feb 5, 2025
4 checks passed
@ADIMANV ADIMANV deleted the Update-docs branch February 5, 2025 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants