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.

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

Further enhance documentation. #95

Closed
2 of 7 tasks
MaxDall opened this issue Mar 15, 2023 · 1 comment
Closed
2 of 7 tasks

Further enhance documentation. #95

MaxDall opened this issue Mar 15, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@MaxDall
Copy link
Collaborator

MaxDall commented Mar 15, 2023

The current documentation and guidelines lacks crucial information and should be expanded with the following:

how_to_contribute.md

  • A best practice for contributing a parser (First add to publisher collection -> validation -> ...)
  • A simple rule on how to choose where to use the information from (meta vs ld vs layout)
  • A explain of the functionality of BaseParser.parse() and it's correlation with Precomputed (should be done after More descriptive naming schema for Precomputed #94)
  • Remove @function from documentation since it isn't is use yet.

attribute_guidelines.md

  • Add commonly used extraction patterns to attributes. i.e:
self.precomputed.ld.bf_search("datePublished")

code documentation

  • Add precise documentation to src/parser/html_parser/utils.py
  • Change parameter naming schema
@MaxDall MaxDall added the documentation Improvements or additions to documentation label Mar 15, 2023
@dobbersc
Copy link
Collaborator

Added to the first point: Also some common patterns for the attributes fields. E.g. keywords and topics for the topics attribute.

@MaxDall MaxDall changed the title Further enhance contributing documentation. Further enhance documentation. Mar 15, 2023
@MaxDall MaxDall closed this as completed Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants