Skip to content

Commit 7b78446

Browse files
committed
markdown styling tweak to be in line with prettier's defaults
1 parent a908207 commit 7b78446

File tree

3 files changed

+82
-82
lines changed

3 files changed

+82
-82
lines changed

CHANGELOG.md

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,30 @@
2121
### New Endpoint Coverage
2222

2323
- Account Calendars (Thanks, [@dmols](https://github.com/dmols))
24-
- List available account calendars
25-
- Get a single account calendar
26-
- Update a calendar's visibility
27-
- Update many calendars' visibility
28-
- List all account calendars
24+
- List available account calendars
25+
- Get a single account calendar
26+
- Update a calendar's visibility
27+
- Update many calendars' visibility
28+
- List all account calendars
2929
- Enrollments (Thanks, [@svanderwulp](https://github.com/svanderwulp))
30-
- Accept Course Invitation
31-
- Reject Course Invitation
30+
- Accept Course Invitation
31+
- Reject Course Invitation
3232
- File (Thanks, [@bennettscience](https://github.com/bennettscience))
33-
- Update File
33+
- Update File
3434
- JWTs (Thanks [@dmols](https://github.com/dmols))
35-
- Create JWTs
36-
- Refresh JWTs
35+
- Create JWTs
36+
- Refresh JWTs
3737
- Moderation Grading (Moderation Set)
38-
- List students selected for moderation
39-
- Select students for moderation
38+
- List students selected for moderation
39+
- Select students for moderation
4040
- Query Course Events (Thanks, [@dmols](https://github.com/dmols))
41-
- Query by course
42-
- Query by account
41+
- Query by course
42+
- Query by account
4343
- Rubrics (Thanks, [@bennettscience](https://github.com/bennettscience))
44-
- Create, Update, and Delete Rubric Assessments
45-
- Create a Rubric Association
44+
- Create, Update, and Delete Rubric Assessments
45+
- Create a Rubric Association
4646
- Users
47-
- Terminate all user sessions (Thanks, [@lucas-salas](https://github.com/lucas-salas))
47+
- Terminate all user sessions (Thanks, [@lucas-salas](https://github.com/lucas-salas))
4848

4949
### General
5050

@@ -144,11 +144,11 @@
144144

145145
- Custom Gradebook Columns (Thanks,[@aileenpongnon](https://github.com/aileenpongnon))
146146
- Files
147-
- Resolve Path (Thanks,[@dsavransky](https://github.com/dsavransky))
147+
- Resolve Path (Thanks,[@dsavransky](https://github.com/dsavransky))
148148

149149
### Bugfixes
150150

151-
- Fixed an issue where `Quiz.get_quiz_group` incorrectly set `course_id` to the quiz ID. (Thanks,[@hcolclou](https://github.com/hcolclou))
151+
- Fixed an issue where `Quiz.get_quiz_group` incorrectly set `course_id` to the quiz ID. (Thanks,[@hcolclou](https://github.com/hcolclou))
152152
- Fixed an issue where `Course.create_external_tool` didn't accept `client_id` (LTI 1.3 support).
153153
- Fixed an issue where `Module.create_module_item` didn't (Thanks,[@aileenpongnon](https://github.com/aileenpongnon) and [@onomou](https://github.com/onomou))
154154
- Fixed an issue where `Page.revert_to_revision` would incorrectly always set `group_id` to the page ID. Now correctly sets `group_id` or `course_id` appropriately.
@@ -184,9 +184,9 @@
184184
### New Endpoint Coverage
185185

186186
- Enrollment Terms
187-
- Get a Single Enrollment Term (Thanks, [@lcamacho](https://github.com/lcamacho))
187+
- Get a Single Enrollment Term (Thanks, [@lcamacho](https://github.com/lcamacho))
188188
- Files
189-
- Resolve Path for Course (Thanks,[@dsavransky](https://github.com/dsavransky))
189+
- Resolve Path for Course (Thanks,[@dsavransky](https://github.com/dsavransky))
190190
- GraphQL (Thanks,[@jonespm](https://github.com/jonespm))
191191
- Late Policy (Thanks, [@kennygperez](https://github.com/kennygperez))
192192
- Quiz Assignment Overrides (Thanks, [@kennygperez](https://github.com/kennygperez))
@@ -199,11 +199,11 @@
199199
### Deprecation Warnings
200200

201201
- :warning: **_This is the final release with support for Python 2.7_** :warning:
202-
- [Python 2.7 is end-of-life as of January 2020](https://www.python.org/doc/sunset-python-2/)
203-
- Future releases of CanvasAPI will *NOT* support any version of Python 2
202+
- [Python 2.7 is end-of-life as of January 2020](https://www.python.org/doc/sunset-python-2/)
203+
- Future releases of CanvasAPI will _NOT_ support any version of Python 2
204204
- :warning: **_This is the final release with support for Python 3.4_** :warning:
205-
- [Python 3.4 is end-of-life as of March 2019](https://www.python.org/downloads/release/python-3410/)
206-
- Future releases of CanvasAPI will *NOT* support Python 3.4 or below
205+
- [Python 3.4 is end-of-life as of March 2019](https://www.python.org/downloads/release/python-3410/)
206+
- Future releases of CanvasAPI will _NOT_ support Python 3.4 or below
207207
- This is the final deprecation warning for all methods marked as deprecated in this changelog or in our documentation. They will be removed in the next release.
208208

209209
### Bugfixes
@@ -222,7 +222,7 @@
222222

223223
- Assignment Extensions (Thanks, [@ljoks](https://github.com/ljoks))
224224
- AssignmentGroup (Thanks, [@ctcuff](https://github.com/ctcuff))
225-
- List Assignments
225+
- List Assignments
226226
- Authentications Log (Thanks, [@weining-li](https://github.com/weining-li))
227227
- Brand Configs (Thanks, [@bennettscience](https://github.com/bennettscience))
228228
- Comm Messages (Thanks, [@ljoks](https://github.com/ljoks))
@@ -256,30 +256,30 @@
256256
### New Endpoint Coverage
257257

258258
- API Token scopes (Thanks, [@jrsilveti](https://github.com/jrsilveti))
259-
- List scopes
259+
- List scopes
260260
- Account Notifications (Thanks, [@jrsilveti](https://github.com/jrsilveti))
261-
- Show a global notification
262-
- Update a global notification
261+
- Show a global notification
262+
- Update a global notification
263263
- Account Reports (Thanks, [@jrsilveti](https://github.com/jrsilveti))
264-
- Start a report
265-
- Status of a report
266-
- Delete a report
264+
- Start a report
265+
- Status of a report
266+
- Delete a report
267267
- Collaborations (Thanks, [@jrsilveti](https://github.com/jrsilveti))
268-
- List collaborations
269-
- List members of a collaboration
268+
- List collaborations
269+
- List members of a collaboration
270270
- Feature Flags (Thanks, [@cat0698](https://github.com/cat0698))
271-
- List features
272-
- List enabled features
273-
- Get feature flag
274-
- Set feature flag
275-
- Remove feature flag
271+
- List features
272+
- List enabled features
273+
- Get feature flag
274+
- Set feature flag
275+
- Remove feature flag
276276
- Rubric (Thanks, [@cat0698](https://github.com/cat0698))
277-
- Create a single rubric
277+
- Create a single rubric
278278

279279
### General
280280

281281
- Removed overzealous global enabling of `DeprecationWarning`. (Thanks, [@Screeeech](https://github.com/Screeeech))
282-
- *Note:* `DeprecationWarnings` are disabled by default, so you may need to run your code with `python -Wd` to see them.
282+
- _Note:_ `DeprecationWarnings` are disabled by default, so you may need to run your code with `python -Wd` to see them.
283283

284284
## [0.13.0] - 2019-07-08
285285

@@ -292,14 +292,14 @@
292292
- Outcome Import (Thanks, [@jrsilveti](https://github.com/jrsilveti))
293293
- Peer Reviews (Thanks, [@vutoan1245](https://github.com/vutoan1245))
294294
- Planner (Thanks, [@weining-li](https://github.com/weining-li))
295-
- Planner
296-
- Planner Notes
297-
- Planner Overrides
295+
- Planner
296+
- Planner Notes
297+
- Planner Overrides
298298
- Polls (Thanks, [@Goff-Davis](https://github.com/Goff-Davis))
299-
- Poll
300-
- PollChoice
301-
- PollSession
302-
- PollSubmission
299+
- Poll
300+
- PollChoice
301+
- PollSession
302+
- PollSubmission
303303
- Quiz Submission Questions (Thanks, [@bradfordlynch](https://github.com/bradfordlynch))
304304

305305
### General
@@ -405,12 +405,12 @@
405405
### Deprecation Warnings
406406

407407
- :warning: **_Dropped support for Python 3.3_** :warning:
408-
- [Python 3.3 is end-of-life as of September 2017](https://www.python.org/dev/peps/pep-0398/#lifespan)
409-
- Should continue to function in 3.3, but compatibility cannot be guaranteed going forward.
408+
- [Python 3.3 is end-of-life as of September 2017](https://www.python.org/dev/peps/pep-0398/#lifespan)
409+
- Should continue to function in 3.3, but compatibility cannot be guaranteed going forward.
410410
- Several methods in the `Course` and `Section` classes relating to assignments and submissions have been deprecated.
411-
- Comparable methods have been implemented in the `Assignment` and `Submission` classes, as appropriate.
412-
- The deprecated methods now include a warning in the documentation with reference to the replacement. Additionally, the deprecated methods will raise a `DeprecationWarning`.
413-
- These methods will be removed in a future release.
411+
- Comparable methods have been implemented in the `Assignment` and `Submission` classes, as appropriate.
412+
- The deprecated methods now include a warning in the documentation with reference to the replacement. Additionally, the deprecated methods will raise a `DeprecationWarning`.
413+
- These methods will be removed in a future release.
414414
- `Course.list_sections()` has been deprecated. Use `Course.get_sections()` instead.
415415

416416
### Bugfixes
@@ -441,12 +441,12 @@
441441
### New Endpoint Coverage
442442

443443
- Account
444-
- Delete a sub account
444+
- Delete a sub account
445445
- Grading Standards (Thanks, [@JonGuilbe](https://github.com/JonGuilbe))
446446
- Notification Preferences (Thanks, [@a-goetz](https://github.com/a-goetz))
447-
- Update a preference
448-
- Update preferences by category
449-
- Update multiple preferences
447+
- Update a preference
448+
- Update preferences by category
449+
- Update multiple preferences
450450
- Outcomes (Thanks, [@a-goetz](https://github.com/a-goetz))
451451
- Quiz Question Groups (Thanks, [@JonGuilbe](https://github.com/JonGuilbe))
452452
- Rubric (Thanks, [@sigurdurb](https://github.com/sigurdurb))
@@ -457,8 +457,8 @@
457457
- For many endpoints that accept an "object id", either a CanvasAPI Object or integer ID can now be passed. (Thanks, [@a-goetz](https://github.com/a-goetz))
458458
- Added a requester cache that remembers the last 5 requests to Canvas. It can be accessed as the attribute `_cache` of the `requester object`. (e.g. `course._requester._cache`)
459459
- Files can now be downloaded directly from the `File` object in one of two ways: (Thanks, [@DanBrink91](https://github.com/DanBrink91))
460-
1. `get_contents` will directly return the contents of the file. (e.g. `file.get_contents()`)
461-
2. `download` will download the file and save it to the provided path. (e.g. `file.download('example.txt')`)
460+
1. `get_contents` will directly return the contents of the file. (e.g. `file.get_contents()`)
461+
2. `download` will download the file and save it to the provided path. (e.g. `file.download('example.txt')`)
462462
- Moved several methods exclusive to the API Key owner's user from the `User` class to a new class called `CurrentUser`. There is a new method in the `Canvas` class called `get_current_user` to access this object. (e.g. `canvas.get_current_user()`) (Thanks, [@DanBrink91](https://github.com/DanBrink91))
463463

464464
### Bugfixes
@@ -609,9 +609,9 @@ Huge thanks to [@liblit](https://github.com/liblit) for lots of issues, suggesti
609609
- Added contribution guide
610610
- Added Docker container for testing (e.g. with Jenkins)
611611
- Split requirements files into three:
612-
- dev_requirements.txt
613-
- tests_requirements.txt
614-
- requirements.txt
612+
- dev_requirements.txt
613+
- tests_requirements.txt
614+
- requirements.txt
615615

616616
### Bugfixes
617617

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ CanvasAPI is a Python library for accessing Instructure’s [Canvas LMS API](htt
1313

1414
## Table of Contents
1515

16-
* [CanvasAPI](#canvasapi)
17-
* [Table of Contents](#table-of-contents)
18-
* [Installation](#installation)
19-
* [Documentation](#documentation)
20-
* [Contributing](#contributing)
21-
* [Quickstart](#quickstart)
22-
* [Working with Canvas Objects](#working-with-canvas-objects)
23-
* [Course objects](#course-objects)
24-
* [User objects](#user-objects)
25-
* [Paginated Lists](#paginated-lists)
26-
* [Keyword arguments](#keyword-arguments)
27-
* [CanvasAPI Projects](#canvasapi-projects)
28-
* [Contact Us](#contact-us)
16+
- [CanvasAPI](#canvasapi)
17+
- [Table of Contents](#table-of-contents)
18+
- [Installation](#installation)
19+
- [Documentation](#documentation)
20+
- [Contributing](#contributing)
21+
- [Quickstart](#quickstart)
22+
- [Working with Canvas Objects](#working-with-canvas-objects)
23+
- [Course objects](#course-objects)
24+
- [User objects](#user-objects)
25+
- [Paginated Lists](#paginated-lists)
26+
- [Keyword arguments](#keyword-arguments)
27+
- [CanvasAPI Projects](#canvasapi-projects)
28+
- [Contact Us](#contact-us)
2929

3030
## Installation
3131

@@ -156,12 +156,12 @@ For a more detailed description of how CanvasAPI handles more complex keyword ar
156156

157157
Since its initial release in June 2016, CanvasAPI has amassed over 100 [dependent repositories](https://github.com/ucfopen/canvasapi/network/dependents). Many of these include various tools used to enhance the Canvas experience for both instructors and students. Here are a few popular repositories that use CanvasAPI:
158158

159-
* [Canvas Grab](https://github.com/skyzh/canvas_grab)
160-
* Canvas Grab is the most popular project using CanvasAPI. This tool, with one click, copies all files from Canvas LMS to local directory. CanvasAPI is used in this project to connect to a course and grab its files.
161-
* [Clanvas](https://github.com/marklalor/clanvas)
162-
* Clanvas is a command-line client for Canvas. It uses the already available bash commands plus some additional ones to interact with various features of Canvas from the commmand line.
163-
* [CS221Bot](https://github.com/Person314159/cs221bot)
164-
* CS221Bot is a Discord bot for the CPCS 221 course at University of British Columbia. CanvasAPI is used in this project to connect to and synchronize with a course and get its data, such as announcements, new assignments, and more.
159+
- [Canvas Grab](https://github.com/skyzh/canvas_grab)
160+
- Canvas Grab is the most popular project using CanvasAPI. This tool, with one click, copies all files from Canvas LMS to local directory. CanvasAPI is used in this project to connect to a course and grab its files.
161+
- [Clanvas](https://github.com/marklalor/clanvas)
162+
- Clanvas is a command-line client for Canvas. It uses the already available bash commands plus some additional ones to interact with various features of Canvas from the commmand line.
163+
- [CS221Bot](https://github.com/Person314159/cs221bot)
164+
- CS221Bot is a Discord bot for the CPCS 221 course at University of British Columbia. CanvasAPI is used in this project to connect to and synchronize with a course and get its data, such as announcements, new assignments, and more.
165165

166166
If you have a project that uses CanvasAPI that you'd like to promote, please contact us!
167167

markdown-style.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
rule 'no-trailing-punctuation', :punctuation => '.,;:!'
88
rule 'ol-prefix', :style => 'ordered'
9-
rule 'ul-indent', :indent => 4
9+
rule 'ul-indent', :indent => 2

0 commit comments

Comments
 (0)