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.

Sign up for GitHub

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

Jump to bottom

PEP8 compliance and documentation #6

Closed
astrochun opened this issue Feb 3, 2020 · 2 comments
Closed

PEP8 compliance and documentation #6

astrochun opened this issue Feb 3, 2020 · 2 comments
Assignees
@astrochun
Labels
documentation Improvements or additions to documentation pep8 PEP8 compliance, formatting

Comments

@astrochun
Copy link
Contributor

General issue for best practices. This ticket will remain open indefinitely.
@astrochun astrochun added documentation Improvements or additions to documentation pep8 PEP8 compliance, formatting labels Feb 3, 2020
@astrochun astrochun self-assigned this Feb 3, 2020
astrochun added a commit that referenced this issue Feb 3, 2020
@astrochun
quota: Minor PEP8 formatting (iss #6); Additional docstrings info
8209bf3
@astrochun astrochun changed the title PEP8 compliance PEP8 compliance and documentation Feb 5, 2020
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection.LDAPConnection: Update documentation (iss #6)
e084e09
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection.ual_grouper_base: Update documentation, PEP8 complian…
6dc6470 
…ce (iss #6)
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection: PEP8 compliance (iss #6)
88acdce
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection: Update docstrings for ual_ldap_query, ual_ldap_queri…
ae5160f 
…es, ldap_search (iss #6)
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection: Update docstrings for usage in ual_grouper_base, ual…
4e1af3d 
…_ldap_query, ual_ldap_queries, ldap_search (iss #6)
astrochun added a commit that referenced this issue Feb 5, 2020
@astrochun
ldap_connection: Update docstrings to include output (iss #6)
4b77e07
@astrochun astrochun mentioned this issue Feb 5, 2020
Merged
astrochun added a commit that referenced this issue Feb 6, 2020
@astrochun
delta: Add brief documentation (iss #10, #6)
cd6c735
astrochun added a commit that referenced this issue Mar 3, 2020
@astrochun
ldap_query.LDAPConnection: PEP8 formatting (iss #6, #16)
a6aafd9
astrochun added a commit that referenced this issue Mar 5, 2020
@astrochun
script_run: Move CSV portal retrieval within if portal; Update docume…
c6317b0 
…ntation (iss #16, #6)
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README to include links to ldap3 and requests (iss #21, #6)
b93f0a9
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README to include dry run note (iss #21, #6)
b607d36
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README to add to Overview description (iss #16, #6)
262d8f7
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README to include links to Grouper and data repository (iss #16,
c50fe34 
#6)
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README Overview discussion (iss #16, #6)
06e8bff
astrochun added a commit that referenced this issue Mar 16, 2020
@astrochun
Update README to mention Library patron group (iss #16, #6)
210b0fd
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Update README Overview section (iss #16, #6)
e701bed
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Update README to include UofA Libraries link (iss #16, #6)
69035f7
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Update README for documentation (arguments -> flags) (iss #16, #6)
b57ba63
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Rename config file; update README (iss #16, #6)
8ef9944
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Update README to specify how Grouper groups are determined (iss #16, #6)
14c85f5
astrochun added a commit that referenced this issue Mar 17, 2020
@astrochun
Update README for Grouper membership documentation (iss #16, #6)
c864353
@astrochun astrochun mentioned this issue Mar 17, 2020
Merged
astrochun added a commit that referenced this issue Mar 31, 2020
@astrochun
Update README for --test and --test_reverse information (iss #18, #6)
a09ca7a
astrochun added a commit to astrochun/ReQUIAM that referenced this issue Mar 31, 2020
@astrochun
Update README for --test and --test_reverse information (iss UAL-RE#18,
9857e0d 
UAL-RE#6)
astrochun added a commit that referenced this issue Apr 14, 2020
@astrochun
ldap_query: Update docstrings to use correct imports (iss #6)
f4c9f28
astrochun added a commit that referenced this issue Apr 14, 2020
@astrochun
grouper_query: Update docstrings (iss #6)
20006c2
astrochun added a commit that referenced this issue Apr 14, 2020
@astrochun
delta: Update docstrings (iss #6)
acac6be
@astrochun astrochun mentioned this issue Apr 14, 2020
Merged
astrochun added a commit that referenced this issue Jun 19, 2020
@astrochun
ReQUIAM -> requiam (iss #6)
21f33b1
astrochun added a commit that referenced this issue Jun 19, 2020
@astrochun
Update setup script for package rename (iss #6)
c492bac
astrochun added a commit that referenced this issue Jun 19, 2020
@astrochun
Update docstrings (iss #6)
ba7b2f8
astrochun added a commit that referenced this issue Jun 19, 2020
@astrochun
Bump version: v0.9.0 -> v0.9.1 (iss #6)
1f467a3
@astrochun
Copy link
Contributor Author

astrochun commented Jul 21, 2020 •
edited
Loading

README.md has been a bit outdated. It needs to include discussion of

  • Provide description on configuration settings [6194252]
  • Documentation of manual override [338c08f]

astrochun added a commit that referenced this issue Jul 21, 2020
@astrochun
Update README with config settings section #6
61942b2 
Minor fixes
astrochun added a commit that referenced this issue Jul 21, 2020
@astrochun
Update to README.md to discuss manual override configuration settings #6
338c08f
astrochun added a commit that referenced this issue Jul 22, 2020
@astrochun
Bump version to 0.10.1 #6
8efa78d
astrochun added a commit that referenced this issue Sep 10, 2020
@astrochun
ManualOverride: update docstrings #6
ca84e7f
astrochun added a commit that referenced this issue Sep 15, 2020
@astrochun
GrouperAPI: params formatting #42
03742fd 
PEP8 formatting #6
astrochun added a commit that referenced this issue Sep 15, 2020
@astrochun
add_grouper_groups: Adjust inputs #42
d34ec84 
Add docstrings #6
astrochun added a commit that referenced this issue Sep 21, 2020
@astrochun
GrouperAPI: PEP8 documentation #6
905ced8 
Minor change with allowed group_type
astrochun added a commit that referenced this issue Sep 21, 2020
@astrochun
GrouperAPI: docstrings #6
8746d98
astrochun added a commit that referenced this issue Sep 21, 2020
@astrochun
GrouperAPI: Add Grouper API documentation #6
37d73a7
astrochun added a commit that referenced this issue Sep 28, 2020
@astrochun
Update README.md for Grouper API feature #42 #6
db7c3f9
astrochun added a commit that referenced this issue Sep 28, 2020
@astrochun
add_grouper_groups: Update docstrings #42 #6
5030b07
astrochun added a commit that referenced this issue Sep 30, 2020
@astrochun
Update README.md changelog for minor improvements #6 #62 #63 #64
6115f6e
astrochun added a commit that referenced this issue Oct 6, 2020
@astrochun
Update README.md - simplify execution instructions #6
0122d56
@damian-romero
Copy link
Contributor

damian-romero commented Nov 25, 2020 •
edited
Loading

While working on #93 I found some style issues including:

  1. multiple spaces before assignments in several scripts as in scripts/org_code_numbers.py
a    = 'a'
ab   = 'ab'
abc  = 'abc'
  1. F-strings with no place holders as in f'foo bar' in scripts/manual_override.py
  2. Some unused imports like from os import path and from os import mkdir in scripts/org_code_numbers.py

I am not sure if 1 is for clarity, but I think fixing the other ones could be part of this issue.

damian-romero pushed a commit that referenced this issue Nov 25, 2020
Fix empty lines with whitespace in ldap_query.py #6
0b83186
@damian-romero damian-romero mentioned this issue Nov 25, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@astrochun astrochun

Labels
documentation Improvements or additions to documentation pep8 PEP8 compliance, formatting
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@damian-romero @astrochun