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

BHoM_Engine: Created DocumentationURL #3073

Merged
merged 4 commits into from
Jun 6, 2023

Conversation

desaiwangBH
Copy link
Contributor

Issues addressed by this PR

Closes #3027

Added a method to create links to the BHoM wiki documentation.

Test files

Changelog

  • Added a method to create links to the BHoM wiki documentation.

Additional comments

@desaiwangBH desaiwangBH added the type:feature New capability or enhancement label Jun 6, 2023
@desaiwangBH desaiwangBH self-assigned this Jun 6, 2023
Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

I was thinking about this - we don't call the documentation a wiki, we refer to it as documentation, and I wonder if therefore the method should reflect that as well? One to discuss in addition to the comments on the code, but great start @desaiwangBH 😄

BHoM_Engine/Query/GetWikiURL.cs Outdated Show resolved Hide resolved
BHoM_Engine/Query/GetWikiURL.cs Outdated Show resolved Hide resolved
BHoM_Engine/Query/GetWikiURL.cs Outdated Show resolved Hide resolved
BHoM_Engine/Query/GetWikiURL.cs Outdated Show resolved Hide resolved
@desaiwangBH
Copy link
Contributor Author

@BHoMBot check compliance

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@desaiwangBH to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

@desaiwangBH
Copy link
Contributor Author

@BHoMBot check required

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@desaiwangBH to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check core
  • check null-handling
  • check serialisation
  • check versioning
  • check installer

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@FraserGreenroyd FraserGreenroyd changed the title BHoM_Engine: Created GetWikiURL BHoM_Engine: Created GetDocumentationURL Jun 6, 2023
Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

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

This looks good to me now, thanks @desaiwangBH

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check ready-to-merge

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check ready-to-merge

@FraserGreenroyd FraserGreenroyd changed the title BHoM_Engine: Created GetDocumentationURL BHoM_Engine: Created DocumentationURL Jun 6, 2023
@FraserGreenroyd
Copy link
Contributor

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: unit-tests

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

desaiwangBH and others added 4 commits June 6, 2023 22:44
Created GetWikiURL
method name change to better reflect function
Co-authored-by: Fraser Greenroyd <[email protected]>
Changed GetDocumentationURL to DocumentationURL and also resolved merge conflicts.
@FraserGreenroyd FraserGreenroyd force-pushed the BHoM_Engine-#3027-BHoMWikiURLMethodAdded branch from 0baef74 to 21ac418 Compare June 6, 2023 21:51
@FraserGreenroyd
Copy link
Contributor

@BHoMBot check core
@BHoMBot check compliance

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check core
  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

@FraserGreenroyd
Copy link
Contributor

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: versioning, installer, serialisation, ready-to-merge, null-handling, unit-tests

@bhombot-ci
Copy link

bhombot-ci bot commented Jun 6, 2023

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

@FraserGreenroyd FraserGreenroyd merged commit f98edda into develop Jun 6, 2023
@FraserGreenroyd FraserGreenroyd deleted the BHoM_Engine-#3027-BHoMWikiURLMethodAdded branch June 6, 2023 21:53
@bhombot-ci bhombot-ci bot mentioned this pull request Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New capability or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Modify all website urls within BHoM related repositories to reference a central location
2 participants