Skip to content

Improve get_cams documentation #1416

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

Merged
merged 15 commits into from
Mar 3, 2022
Merged

Improve get_cams documentation #1416

merged 15 commits into from
Mar 3, 2022

Conversation

soma2000-lang
Copy link
Contributor

@soma2000-lang soma2000-lang commented Mar 2, 2022

@soma2000-lang
Copy link
Contributor Author

@AdamRJensen please look into this pr

@AdamRJensen
Copy link
Member

@soma2000-lang I noticed that the stickler-ci check is failing, which means that there is some formatting check that is not passing, e.g., a line that is too longer than 79 characters. You can click the "Details" button to the right of the stickler-ci to see the error.

@AdamRJensen
Copy link
Member

It happens sometimes that you fix a stickler error, only to break another rule. Btw, I thought it was nice when you spelled out approximately in full.

@soma2000-lang
Copy link
Contributor Author

@AdamRJensen yes the error was showing that remove the trailing whitesapces ,I tried to solve that using
Find > Replace...
Find What: [ \t]+\n
Replace With: \n
Replace All

these steps but its still showing the same error .Can you please help me in this regard

@AdamRJensen
Copy link
Member

AdamRJensen commented Mar 2, 2022

@soma2000-lang The trailing white space refers to one or more spaces at the end of a line. The stickler-ci will show the warning just below the affected line, so that should help you find it another time.

Copy link
Member

@AdamRJensen AdamRJensen left a comment

Choose a reason for hiding this comment

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

Otherwise it looks good :)

@@ -363,7 +360,7 @@ def read_cams(filename, integrated=False, label=None, map_variables=True):

See Also
--------
pvlib.iotools.parse_cams, pvlib.iotools.get_cams
pvlib.iotools.parse_cams,pvlib.iotools.get_cams
Copy link
Member

Choose a reason for hiding this comment

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

You can go ahead and put this space back since this was not the trailing white space.

Copy link
Member

@cwhanse cwhanse left a comment

Choose a reason for hiding this comment

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

latitude and longitude for CAMS Radiation


Geographical coverage:worldwide for CAMS McClear and approximately -66° to
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Geographical coverage:worldwide for CAMS McClear and approximately -66° to
Geographical coverage: worldwide for CAMS McClear and approximately -66° to

@soma2000-lang
Copy link
Contributor Author

@AdamRJensen @cwhanse made the suugested changes

@AdamRJensen
Copy link
Member

@soma2000-lang There still is two stickler-ci lines being flagged.

Notice that the stickler-ci tells you which line the errors are on, in this case "Check failure on line 61 and the error is blank line contains white space.
image

Almost there :)

@cwhanse
Copy link
Member

cwhanse commented Mar 2, 2022

@soma2000-lang please add yourself to the Contributors section of docs/source/sphinx/whatsnew/v0.9.1.rst

@cwhanse cwhanse mentioned this pull request Mar 2, 2022
Co-authored-by: Adam R. Jensen <[email protected]>
@cwhanse cwhanse added this to the 0.9.1 milestone Mar 3, 2022
@cwhanse cwhanse merged commit 35fc5e9 into pvlib:master Mar 3, 2022
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.

Improve get_cams documentation
3 participants