Skip to content

Conversation

@adrianlacour-indico
Copy link
Contributor

Summary

Adds the following:

  • Adds a few more attributes to the Datafile type (pages, page_ids, and num_pages)
  • Adds the DataFilePage class type, so it can be used by the newly added pages attribute.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • Jira story/task is put into PR title
  • Code has been self-reviewed
  • Hard-to-understand areas have been commented
  • Documentation has been updated
  • My changes generate no new warnings

@adrianlacour-indico adrianlacour-indico marked this pull request as ready for review November 3, 2021 20:29
@goatrocks
Copy link
Contributor

goatrocks commented Nov 4, 2021

Thanks for doing this! Is this tied to any newer version of the platform?

Also, do you mind running sphinx build to generate updated docs?

@adrianlacour-indico
Copy link
Contributor Author

adrianlacour-indico commented Nov 4, 2021

Thanks for doing this! Is this tied to any newer version of the platform?

Also, do you mind running sphinx build to generate updated docs?

Nope, the Fog code has at least been there for a few years, so don't think it'd be an issue: https://github.com/IndicoDataSolutions/fog/blame/32862d2fd3029f06c7dab6de0440a10b144f8599/fog/schema/datafile.py#L28

And sure! I don't mind doing it, but I wasn't able to find any documentation on it in Confluence or in this repo. Could you give me a quick rundown or a link? If there's no current documentation on it, I can make some up and add it to the SDK Setup Confluence page (once I know how to do it)

@goatrocks
Copy link
Contributor

And sure! I don't mind doing it, but I wasn't able to find any documentation on it in Confluence or in this repo. Could you give me a quick rundown or a link? If there's no current documentation on it, I can make some up and add it to the SDK Setup Confluence page (once I know how to do it)

Sweet! It should just be a pip install sphinx and sphinx-build docsrc docs . I'll add it to the confluence docs -- since I need to update the java section anyway. Thanks!

@adrianlacour-indico
Copy link
Contributor Author

And sure! I don't mind doing it, but I wasn't able to find any documentation on it in Confluence or in this repo. Could you give me a quick rundown or a link? If there's no current documentation on it, I can make some up and add it to the SDK Setup Confluence page (once I know how to do it)

Sweet! It should just be a pip install sphinx and sphinx-build docsrc docs . I'll add it to the confluence docs -- since I need to update the java section anyway. Thanks!

Alrighty, thank ya! Ran it and pushed up the changes. It looks like there was a lot of deletion, but I think the majority of it were empty lines. However, there's some places where it seems like it just deleted lines that were there before, like in basic.css. May be becuase I don't have some extensions or something installed, but I installed all of the ones it fussed at me for (sphinx_rtd_theme and sphinx_autodoc_typehints)

@goatrocks
Copy link
Contributor

lgtm, you can preview the docs if you open index.html on your local machine, took a peek and seems like it's fine!

@goatrocks goatrocks merged commit 689e124 into master Nov 5, 2021
@adrianlacour-indico adrianlacour-indico deleted the adrian/update_datafile branch November 5, 2021 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants