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

1.0 advanced usage documentation #182

Closed
4 tasks done
masklinn opened this issue Feb 6, 2024 · 0 comments · Fixed by #202
Closed
4 tasks done

1.0 advanced usage documentation #182

masklinn opened this issue Feb 6, 2024 · 0 comments · Fixed by #202
Milestone
1.0

Comments

@masklinn
Copy link
Contributor

masklinn commented Feb 6, 2024 •
edited
Loading

  • explain basic principles the parser API, base parsers and parser adapters / decorators
  • list and explain the base parsers
  • list and explain the cache-related parsers adapters
  • document the ability to hook a custom parser as global

Not sure if the loaders stuff belongs here or in the base guide, in 0.x custom yaml data sets is an "advanced feature" because you need to start your software with the right envvars. Here it's just loading stuff from a json or yaml file (or even some other format as long as the schema is correct once deserialized).
@masklinn masklinn mentioned this issue Feb 6, 2024
Closed
4 tasks
@masklinn masklinn added this to the 1.0 milestone Feb 6, 2024
@masklinn masklinn mentioned this issue Feb 6, 2024
Closed
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 16, 2024
@masklinn
add caching and resolver guides
ecdd2fa 
Fixes ua-parser#182
@masklinn masklinn linked a pull request Mar 16, 2024 that will close this issue
Add Documentation #202
Merged
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 24, 2024
@masklinn
add caching and resolver guides
2fc3261 
Fixes ua-parser#182
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 25, 2024
@masklinn
add caching and resolver guides
816cbff 
Fixes ua-parser#182
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 26, 2024
@masklinn
add caching and resolver guides
5467bb3 
Fixes ua-parser#182
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 26, 2024
@masklinn
Initial doc: installation, quickstart, API doc
c3f2533 
Trimmed the readme, and added a bit on re2.

Had to update a ton of docstrings to have a decent API doc.

Also removed a bunch of leftover references to parsers, and removed
the completely useless `Parse` bit from `ParseResult`,
`PartialParseResult`, and `DefaultedParseResult`, which further
contributed to the churn and every file in the project being touched,
as it required editing files without docstrings.

Fixes ua-parser#182
masklinn added a commit to masklinn/uap-python that referenced this issue Mar 26, 2024
@masklinn
Initial doc: installation, quickstart, API doc
445f7d8 
Trimmed the readme, and added a bit on re2.

Had to update a ton of docstrings to have a decent API doc.

Also removed a bunch of leftover references to parsers, and removed
the completely useless `Parse` bit from `ParseResult`,
`PartialParseResult`, and `DefaultedParseResult`, which further
contributed to the churn and every file in the project being touched,
as it required editing files without docstrings.

Fixes ua-parser#182
masklinn added a commit that referenced this issue Mar 26, 2024
@masklinn
Initial doc: installation, quickstart, API doc
6c3fce7 
Trimmed the readme, and added a bit on re2.

Had to update a ton of docstrings to have a decent API doc.

Also removed a bunch of leftover references to parsers, and removed
the completely useless `Parse` bit from `ParseResult`,
`PartialParseResult`, and `DefaultedParseResult`, which further
contributed to the churn and every file in the project being touched,
as it required editing files without docstrings.

Fixes #182
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

Add Documentation masklinn/uap-python
1 participant
@masklinn