8000 fix pasting from the documentation by dothebart · Pull Request #9742 · arangodb/arangodb · GitHub
[go: up one dir, main page]

Skip to content

fix pasting from the documentation #9742

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 pr 8000 ivacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 19, 2019

Conversation

dothebart
Copy link
Contributor

Scope & Purpose

In ArangoDB 2.8 one could cut'n'paste code snippets including their arangosh> prefixes as seen here:
https://www.arangodb.com/docs/stable/graphs.html#example-graphs
This wasn't possible anymore. This PR fixes that.

  • Bug-Fix for 3.0 - present
  • The behavior in this PR can be manually tested
  • The behavior change can be verified via automatic tests

Related Information

This change is a trivial rework / code cleanup without any test coverage.
http://jenkins01.arangodb.biz:8080/view/PR/job/arangodb-matrix-pr/5750/

Documentation

  • Added a Changelog Entry

Copy link
Contributor
@Simran-B Simran-B left a comment

Choose a reason for hiding this comment

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

Okay for the time being, but the examples should actually not include such prefixes in the first place. We should instead add kind of a headline that tells the user what the environment is (arangosh, sh, cmd, ps, driver...). That will be tackled as part of the data model(ing) refactor, probably for v3.6.

@dothebart
Copy link
Contributor Author

Tests green.

@KVS85 KVS85 merged commit 61f6143 into devel Aug 19, 2019
ObiWahn added a commit that referenced this pull request Aug 22, 2019
…ture/mimalloc

* 'devel' of https://github.com/arangodb/arangodb: (83 commits)
  Bug fix/internal issue #622 (#9781)
  mark AQL functions FULLTEXT, NEAR, WITHIN, WITHIN_RECTANGLE as cacheable (#9771)
  reduce wait timeout, use move
  Bug fix/implement windows maintenance tests (#9763)
  show query string length and cacheability in explain output (#9767)
  fix potential spurious wakeups in scheduler code (#9770)
  Bug fix/issue #9612 (#9764)
  downgrade WARN messages to INFO level (#9761)
  slightly reorder boolean members to reduce struct sizes (#9762)
  make index selection more deterministic (#9735)
  Update PULL_REQUEST_TEMPLATE.md (#9758)
  [devel] Move Shard Bug 4567124 (#9746)
  Bug fix/fix signed int overflow (#9717)
  Bug fix/fix invalid cast (#9755)
  Enforce stricter transaction limits (#9740)
  Check scheduler queue return value (#9754)
  dont fill cache on truncate (#9721)
  fix pasting from the documentation (#9742)
  tell that procdump is gone - it seems this happenes in reality without coredumps being written (#9748)
  issue #9654: make `--rocksdb.max-write-buffer-number` work (#9750)
  ...
ObiWahn added a commit that referenced this pull request Aug 23, 2019
…ture/one-shard-db

* 'devel' of https://github.com/arangodb/arangodb: (53 commits)
  remove 404-ed callbacks from agency (#9709)
  AQL date functions improvements (#9714)
  Bug fix/internal issue #622 (#9781)
  mark AQL functions FULLTEXT, NEAR, WITHIN, WITHIN_RECTANGLE as cacheable (#9771)
  reduce wait timeout, use move
  Bug fix/implement windows maintenance tests (#9763)
  show query string length and cacheability in explain output (#9767)
  fix potential spurious wakeups in scheduler code (#9770)
  Bug fix/issue #9612 (#9764)
  downgrade WARN messages to INFO level (#9761)
  slightly reorder boolean members to reduce struct sizes (#9762)
  make index selection more deterministic (#9735)
  Update PULL_REQUEST_TEMPLATE.md (#9758)
  [devel] Move Shard Bug 4567124 (#9746)
  Bug fix/fix signed int overflow (#9717)
  Bug fix/fix invalid cast (#9755)
  Enforce stricter transaction limits (#9740)
  Check scheduler queue return value (#9754)
  dont fill cache on truncate (#9721)
  fix pasting from the documentation (#9742)
  ...
@fceller fceller deleted the bug-fix/fix-arangosh-documentation-paste branch September 6, 2019 11: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.

4 participants
0