Skip to content

Fix for dph documentation warnings#15

Closed
Greeshma-Rajendran wants to merge 4 commits into
mainfrom
fix_dph_doc_warnings
Closed

Fix for dph documentation warnings#15
Greeshma-Rajendran wants to merge 4 commits into
mainfrom
fix_dph_doc_warnings

Conversation

@Greeshma-Rajendran
Copy link
Copy Markdown
Member

Fixes the DPH documentation warnings

Signed-off-by: Greeshma Rajendran <greeshma.rajendran@hotmail.com>
Signed-off-by: Greeshma Rajendran <greeshma.rajendran@hotmail.com>
Signed-off-by: Greeshma Rajendran <greeshma.rajendran@hotmail.com>
Signed-off-by: Greeshma Rajendran <greeshma.rajendran@hotmail.com>
@srikanth-ibm
Copy link
Copy Markdown
Member

@Greeshma-Rajendran You have to create PR against 'sandbox' branch first.
Please check this document: https://github.ibm.com/wdp-gov/data-intelligence-sdk/wiki/Team-onboarding-guide#development-flow

:inherited-members:

Common Models
-------------
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you meant to remove these? I don't see any models or APIs in the API reference for the edited files after building the documentation.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, these are to be removed as the detailed documentation is already present in the specific folders.

@knish-99
Copy link
Copy Markdown
Member

@srikanth-ibm @Greeshma-Rajendran For fixes that are not intended to bump up the version, it is sufficient to raise a PR to main. Not sure about the current PR which modifies documentation in source code.

I also need to go back and sync sandbox with main. This should only be necessary if there's a squash merge from sandbox to main (which breaks tagging, so not recommended).

@srikanth-ibm
Copy link
Copy Markdown
Member

@knish-99
Shouldn't the 'sandbox' branch branch be in sync with 'main' branch?
If they are not synced, new PR's where there are true code changes could be impacted, isn't that the case?

May be we need a flow as:

  • Generating version is option for 'Sandbox' (Today, a merged PR to sandbox will trigger a build and push to testpypi. Not optional)

AFAIR, merging to 'main' dont auto trigger build and publish to pypi. This is all manual. Please confirm.

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