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

Test and documentation inventory #372

Closed
ruebot opened this issue Nov 6, 2019 · 3 comments
Closed

Test and documentation inventory #372

ruebot opened this issue Nov 6, 2019 · 3 comments
Assignees
@ruebot
Labels
documentation tests

Comments

@ruebot
Copy link
Member

ruebot commented Nov 6, 2019

This ticket is meant to evaluate the current documentation against tests. Make sure the tests and examples are consistent. If there is a difference, not them below in a comment. Then create a pull request for each one, or all of them.

Current documentation examples are here, and pull requests should be made against that repo as necessary, and should reference this issue.

Where tests are missing, check and see if an issue exists. If one does not exist, please create one, or let us know in a comment.
@ruebot
Copy link
Member Author

ruebot commented Nov 8, 2019

@SinghGursimran here's one for you.

@ruebot ruebot mentioned this issue Nov 8, 2019
Closed
@ruebot
Copy link
Member Author

ruebot commented Jan 15, 2020

Documentation inventory and review. Lots to discuss here.

Filters

  • Python implementation of UDF filters.

Binary Analysis

Collection Analysis

DF Results

Index

Link Analysis

Setting up the Archives Unleashed Toolkit

  • Fix ToC
  • Review closer and align with README

Standard Derivatives

Text Analysis

ruebot added a commit that referenced this issue Jan 16, 2020
@ruebot
Address #372 - DRAFT
debf5d5
ruebot added a commit to archivesunleashed/aut-docs that referenced this issue Jan 16, 2020
@ruebot
Address archivesunleashed/aut#372 - DRAFT
88789a9
This was referenced Jan 16, 2020
Merged
Merged
ianmilligan1 pushed a commit that referenced this issue Jan 17, 2020
@ruebot @ianmilligan1
Various DataFrame implementation updates for documentation clean-up; …
9277e68 
…Addresses #372.

- .all() column HttpStatus to http_status_code
- Adds archive_filename to .all()
- Significant README updates for setup
- See also: archivesunleashed/aut-docs#39
ruebot added a commit to archivesunleashed/aut-docs that referenced this issue Jan 20, 2020
@ruebot
Update documentation for archivesunleashed/aut#372 (#39)
4ce3cb5 
* Add DF results Python section
* Add won't implement language to binary analysis.
* Add won't implement language to standard derivatives.
* Remove index, fix ToC in setting up.
* Update README, add scala df to link analys, add TSV rdd results
* text-analysis scala df
* Add to be implemented
* Resolves #22
ruebot added a commit that referenced this issue Jan 21, 2020
@ruebot
Clean up test descriptions, addresses #372.
6bfbb33 
- Rename typo filename
- Remove potentially unnecessary tests
@ruebot ruebot mentioned this issue Jan 21, 2020
Merged
ianmilligan1 pushed a commit that referenced this issue Jan 21, 2020
@ruebot @ianmilligan1
Clean up test descriptions, addresses #372. (#416)
ffef735 
- Clean up test descriptions
- Rename typo filename
@ruebot
Copy link
Member Author

ruebot commented Jan 22, 2020

I think we're good here now.

@ruebot ruebot closed this as completed Jan 22, 2020
@ruebot ruebot self-assigned this Jan 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ruebot ruebot

Labels
documentation tests
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ruebot